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

本文内容

您可以将自动链接添加到 JIRA 议题和 Zendesk 事件单等外部资源，以帮助简化工作流程。

自动链接在包含 GitHub Pro、GitHub Team、GitHub Enterprise Cloud、 和 GitHub Enterprise Server 的存储库中可用。 有关详细信息，请参阅“GitHub 的计划”。

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

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

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

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

此过程演示如何配置自动链接以引用外部资源。 例如，如果使用 Zendesk 跟踪用户报告的工单，可以引用所打开拉取请求中的工单编号来解决问题。

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

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

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

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

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

    “自动链接引用”页的屏幕截图。 以深橙色轮廓突出显示了“添加自动链接引用”按钮。

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

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

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

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

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

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