Enterprise Server 3.15 is currently available as a release candidate.

Configuring autolinks to reference external resources

You can add autolinks to external resources like JIRA issues and Zendesk tickets to help streamline your workflow.

Who can use this feature?

Autolinks are available in repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server.

In this article

Anyone with admin permissions to a repository can configure autolink references to link issues, pull requests, commit messages, and release descriptions to external third-party services.

Autolink references can now accept alphanumeric characters. When originally introduced, custom autolinks were limited to external resources that used numeric identifiers. Custom autolinks now work with alphanumeric and numeric identifiers.

You define custom autolinks by specifying a reference prefix and a target URL.

  • Reference prefixes cannot have overlapping names. For example, a repository cannot have two custom autolinks with prefixes such as TICKET and TICK, since both prefixes would match the string TICKET123a.
  • Target URLs include a <num> variable which represents the reference identifier of the linked resource.

This procedure demonstrates how to configure autolinks to reference external resources. For example, if you use Zendesk to track user-reported tickets, you can reference a ticket number in the pull request you opened to fix the issue.

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

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

  3. In the "Integrations" section of the sidebar, click Autolink references.

  4. At the top right of the page, click Add autolink reference.

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

  5. Select the format of the reference identifier used in the external resource, either Alphanumeric or Numeric.

  6. Under "Reference prefix", type a short, meaningful prefix. Collaborators will use this text to generate autolinks for the external resource.

  7. Under "Target URL", type the format of the link to the external system you want to create. Use the <num> variable as a placeholder for the reference identifier.

  8. Review the preview and verify that the autolink and external reference are both correct, then click Add autolink reference to define the link.

For example, you might enter the following.

  • Reference prefix: JIRA-
  • Target URL: https://jira.example.com/issue?query=<num>
  • Preview: JIRA-123 is converted to https://jira.example.com/issue?query=123