跳至主要内容

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

您可以为外部资源(如 JIRA 问题和 Zendesk 工单)添加自动链接,以帮助简化工作流程。

谁可以使用此功能?

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

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

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

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

  • 引用前缀不能重叠。例如,仓库不能同时拥有前缀为 TICKETTICK 的两个自定义自动链接,因为这两个前缀都会匹配字符串 TICKET123a
  • 目标 URL 包含一个 <num> 变量,代表所链接资源的引用标识符。

本步骤演示如何配置自动链接以引用外部资源。例如,如果您使用 Zendesk 来跟踪用户报告的工单,您可以在用于修复问题的拉取请求中引用工单编号。

  1. 在 GitHub 上,导航至仓库的主页面。

  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
© . This site is unofficial and not affiliated with GitHub, Inc.