Github和gitlab的自动连接

Github 和 Gitlab 提供了一些可能有些人还不了解的语法,可以自动为文字添建连接,关联相关的一些对象,以及执行相应的操作。本文记录了这些小技巧,可以在需要的时候查询。

Github

Github帮助文档中指出了下面的一些技巧。

1、URL

标准的URL地址可以自动加上连接,
比如 Visit https://github.com可以生成
Visit https://github.com

2、引用 Issues 和 pull requests

Reference typeRaw referenceShort link
Issue or pull request URLhttps://github.com/jlord/sheetsee.js/issues/26#26
# and issue or pull request number#26#26
GH- and issue or pull request numberGH-26GH-26
Username/Repository# and issue or pull request numberjlord/sheetsee.js#26jlord/sheetsee.js#26

3、引用commit

Reference typeRaw referenceShort link
Commit URLhttps://github.com/jlord/sheetsee.js/commit/a5c3785ed8d6a35868bc169f07e40e889087fd2ea5c3785
SHAa5c3785ed8d6a35868bc169f07e40e889087fd2ea5c3785
User@SHAjlord@a5c3785ed8d6a35868bc169f07e40e889087fd2ejlord@a5c3785
Username/Repository@SHAUser/Repository@SHA: jlord/sheetsee.js@a5c3785ed8d6a35868bc169f07e40e889087fd2ejlord/sheetsee.js@a5c3785

4、在commit的时候自动关闭issue

文档 Closing issues via commit messages指出,
在commit message中使用下面的关键字加issue号会关闭这个issue,当然这个issue必须和这个commit在同一个库中:

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved

如果要关闭不同的仓库中的issue,需要使用username/repository#issue_number语法,比如Closes example_user/example_repo#76

要关闭多个issue,需要使用多次关键字,比如This closes #34, closes #23, and closes example_user/example_repo#42

Gitlab

gitlab issue #527描述了gitlab类似的语法,可以自动添建连接。

可以在下面的场景中

  • commit messages
  • notes/comments/wall posts
  • issues
  • merge requests
  • milestones
  • wiki pages

使用下面的语法:

  • issues (#123)
  • merge request (!123)
  • commits (1234567)
  • team members (@foo)
  • snippets ($123)
评论