Configurar links automáticos para fazer referência a recursos externos

Você pode adicionar links automáticos para recursos externos como problemas do JIRA e tíquetes do Zendesk a fim de ajudar a otimizar o fluxo de trabalho.

Quem pode usar esse recurso?

Os links automáticos estão disponíveis em repositórios com o GitHub Pro, o GitHub Team, o GitHub Enterprise Cloud e o GitHub Enterprise Server.

Neste artigo

Qualquer pessoa com permissões de administrador para um repositório pode configurar referências de autolink para vincular problemas, pull requests, mensagens do commit e descrições de versões para serviços externos de terceiros.

As referências de link automático agora podem aceitar caracteres alfanuméricos. Logo que foram introduzidos, os links automáticos personalizados eram limitados a recursos externos que usavam identificadores numéricos. Os links automáticos personalizados agora funcionam com identificadores alfanuméricos e numéricos.

Você define os links automáticos personalizados especificando um prefixo de referência e uma URL de destino.

  • Os prefixos de referência não podem ter nomes que se sobreponham. Por exemplo, um repositório não pode ter dois links automáticos personalizados com prefixos como TICKET e TICK, pois os dois prefixos corresponderiam à cadeia de caracteres TICKET123a.
  • As URLs de destino incluem uma variável <num> que representa o identificador de referência do recurso vinculado.

Este procedimento demonstra como configurar links automáticos para referenciar recursos externos. Por exemplo, ao usar o Zendesk para acompanhar tíquetes relatados por usuários, você pode referenciar um número de tíquete na solicitação de pull que foi aberta para corrigir o problema.

  1. Em GitHub, acesse a página principal do repositório.

  2. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na seção "Integrações" da barra lateral, clique em Referências de link automático.

  4. No canto superior direito da página, clique em Adicionar referência de link automático.

    Captura de tela da página "Referências de link automático". O botão "Adicionar referência de link automático" está realçado por um contorno laranja escuro.

  5. Selecione o formato do identificador de referência usado no recurso externo, seja ele Alfanumérico ou Numérico.

  6. Em "Prefixo de referência", digite um prefixo curto e significativo. Os colaboradores usarão esse texto para gerar links automáticos para o recurso externo.

  7. Em "URL de destino", digite o formato do link para o sistema externo que deseja criar. Use a variável <num> como um espaço reservado para o identificador de referência.

  8. Examine a visualização e verifique se o link automático e a referência externa estão corretos e clique em Adicionar referência de link automático para definir o link.

Por exemplo, você pode inserir os itens a seguir.

  • Prefixo de referência: JIRA-
  • URL de Destino: https://jira.example.com/issue?query=<num>
  • Versão prévia: JIRA-123 é convertido em https://jira.example.com/issue?query=123