配置自动链接以引用外部资源

您可以添加自动链接到外部资源，例如 JIRA 问题和 Zendesk 票证，以帮助简化您的工作流程。

谁可以使用此功能？

自动链接在具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的仓库中可用。有关更多信息，请参阅“GitHub 的计划”。

本文档

任何对仓库具有管理员权限的人都可以配置自动链接引用，以将问题、拉取请求、提交消息和发布说明链接到外部第三方服务。

自动链接引用现在可以接受字母数字字符。最初引入时，自定义自动链接仅限于使用数字标识符的外部资源。现在，自定义自动链接可以使用字母数字和数字标识符。

您可以通过指定引用前缀和目标 URL 来定义自定义自动链接。

  • 引用前缀不能有重叠的名称。例如，一个仓库不能有两个自定义自动链接，它们的前缀分别是 TICKET 和 TICK，因为这两个前缀都将匹配字符串 TICKET123a。
  • 目标 URL 包含一个 <num> 变量，它代表链接资源的引用标识符。

此过程演示了如何配置自动链接以引用外部资源。例如，如果您使用 Zendesk 来跟踪用户报告的票证，您可以在您打开的修复问题的拉取请求中引用票证号。

  1. 在 GitHub.com 上，导航到仓库的主页。

  2. 在您的仓库名称下，点击 设置。如果您看不到“设置”选项卡，请选择下拉菜单，然后点击设置。

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  3. 在侧边栏的“集成”部分，点击 自动链接引用。

  4. 在页面右上角，点击添加自动链接引用。

    Screenshot of the "autolink references" page. The "Add autolink reference" button is highlighted by a dark orange outline.

  5. 选择外部资源中使用的引用标识符的格式，可以是字母数字或数字。

  6. 在“引用前缀”下，输入一个简短且有意义的前缀。协作者将使用此文本为外部资源生成自动链接。

  7. 在“目标 URL”中，输入您要创建的指向外部系统的链接格式。使用<num>变量作为引用标识符的占位符。

  8. 查看预览并验证自动链接和外部引用是否都正确，然后单击**添加自动链接引用**以定义链接。

例如，您可以输入以下内容。

  • 引用前缀：JIRA-
  • 目标 URL：https://jira.example.com/issue?query=<num>
  • 预览：JIRA-123将转换为https://jira.example.com/issue?query=123