Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
All products
Repositories

This version of GitHub Enterprise was discontinued on 2023-03-15. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Configuring autolinks to reference external resources

In this article

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

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

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.

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 your GitHub Enterprise Server instance, 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 left 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. Under "Reference prefix", type a short, meaningful prefix. Collaborators will use this text to generate autolinks for the external resource.

  6. 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.

  7. 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