Article version: GitHub.com

Configuring autolinks to reference external resources

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

Autolinks are available in private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

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

If you use Zendesk to track user-reported tickets, for example, you can reference a ticket number in the pull request you open to fix the issue.

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

  2. Under your repository name, click Settings.

    Repository settings button

  3. In the left sidebar, click Autolink references.

    Autolink references tab in the left sidebar

  4. Click Add autolink reference.

    Button to fill out autolink reference information

  5. Under "Reference prefix", type a short, meaningful prefix you want collaborators to use to generate autolinks for the external resource.

    Field to type abbreviation for external system

  6. Under "Target URL", type the link to the external system you want to link to. Make sure to keep <num> as a variable for the reference number.

    Field to type URL to external system

  7. Click Add autolink reference.

    Button to add autolink reference

Ask a human

Can't find what you're looking for?

Contact us