Partilhar via

Associa commits, pull requests, ramos e problemas do GitHub a itens de trabalho no Azure Boards

Azure DevOps Serviços | Azure DevOps Server | Azure DevOps Server 2022

Neste artigo, aprenda como ligar itens de trabalho a commits, pull requests, branches e builds do GitHub depois de ligar o seu projeto Azure Boards a um repositório GitHub. Podes usar a sintaxe #mention para commits e branches, usar ! para mencionar pull requests do GitHub em discussões sobre itens de trabalho, ou adicionar um link de commit, pull request ou branch do GitHub diretamente do item de trabalho do Azure Boards.

Note

GitHub suporte de integração:

  • Azure DevOps Services: Integra-se tanto com repositórios GitHub.com como GitHub Enterprise Server através da aplicação Azure Boards para GitHub.
  • Azure DevOps Server 2020 e posteriores: Suporta integração apenas com repositórios GitHub Enterprise Server.
  • Outros repositórios Git: A integração não é suportada.

Prerequisites

Category Requirements
Permissões Contributor tanto do projeto Azure Boards como do repositório GitHub.
Ligação ao projeto O projeto Azure Boards está conectado ao repositório do GitHub, onde existem os commits, pull requests e a branch à qual quer vincular ou a partir da qual quer vincular. Para mais informações, consulte Azure Boards-GitHub integração.

Note

Para visualizar a secção de Desenvolvimento e os tipos de ligação do GitHub, os projetos que utilizam o modelo de processo XML alojado necessitam de atualizações aos tipos de itens de trabalho. Para obter mais informações, consulte Atualizar definições XML para tipos de item de trabalho selecionados.

A partir de um commit no GitHub, pull request ou issue, utilize a seguinte sintaxe para criar um link para o seu item de trabalho no Azure Boards. Insira o AB#ID texto dentro do texto de uma mensagem de confirmação. Ou, para um pull request ou issue, introduza o AB#ID na descrição. Usar AB#ID em um título de comentário ou de pull request não cria um link no item de trabalho.

AB#{ID}

Por exemplo, AB#125 liga-se ao item de trabalho número 125.

Você também pode inserir uma mensagem de confirmação ou pedido de pull para fazer a transição do item de trabalho. O sistema reconhece {state} ou {state category}, juntamente com fix, fixes, fixed, e aplica-o ao item #-mention que se segue.

Quando uma descrição de solicitação pull inclui um nome de estado válido, por exemplo, Closed AB#1234, o sistema atualiza o item de trabalho referenciado para esse estado específico. Se o nome do estado não for reconhecido diretamente, Azure Boards tenta associá-lo a uma categoria de workflow como Resolved ou Completed. Caso seja encontrada uma correspondência, o item de trabalho passará para o primeiro estado disponível definido nessa categoria.

Por padrão, os itens de trabalho referenciados com fix, fixes ou fixed transitam para o primeiro estado associado à categoria Resolvido. Se esse estado não existir no processo atual, o sistema fará a transição do item de trabalho para o primeiro estado na categoria Concluído .

Important

Você ainda pode vincular itens de trabalho e direcionar outras ramificações, mas as regras de transição de estado não se aplicam, a menos que a solicitação pull seja mesclada na ramificação padrão.

Para obter mais informações, veja Como os estados das categorias do fluxo de trabalho são usados nos backlogs e boards do Azure Boards.

Analise a tabela de exemplos a seguir:

Mensagem de commit ou pedido de pull Action
Fixed AB#123 Vincula e faz a transição do item de trabalho para a categoria Estado do fluxo de trabalho Resolvido ou, se nenhum estiver definido, para a categoria Estado do fluxo de trabalho Concluído .
Closed AB#123 Vincula e faz a transição do item de trabalho para o estado do fluxo de trabalho Fechado . Se nenhuma for definida, nenhuma transição será feita.
Adds a new feature, fixes AB#123. Vincula e faz a transição do item de trabalho para a categoria Estado do fluxo de trabalho Resolvido ou, se nenhum estiver definido, para a categoria Estado do fluxo de trabalho Concluído .
Fixes AB#123, AB#124, and AB#126 Ligações para os itens de trabalho 123, 124 e 126 do Azure Boards. Transiciona apenas o primeiro item, 123 para a categoria Estado do fluxo de trabalho Resolvido ou, se nenhum estiver definido, a categoria Estado do fluxo de trabalho Concluído .
Fixes AB#123, Fixes AB#124, Fixes AB#125 Ligações para os itens de trabalho 123, 124 e 126 do Azure Boards. Transiciona todos os itens para a categoria Estado do fluxo de trabalho Resolvido ou, se nenhum estiver definido, para a categoria Estado do fluxo de trabalho Concluído .
Fixing multiple bugs: issue #123 and user story AB#234 Ligações para a edição 123 do GitHub e para o item de trabalho 234 do Azure Boards. Nenhuma transição é feita.

Note

Se você conectar o mesmo repositório GitHub a projetos definidos em duas ou mais organizações do Azure DevOps, pode ver uma ligação inesperada da menção AB#. Para obter mais informações, consulte Resolver problemas de conexão. Por esta razão, recomendamos que apenas ligue um repositório GitHub a projetos definidos numa única organização Azure DevOps.

Quando adiciona um link a um item de trabalho usando AB# numa descrição de pull request, esses links aparecem na secção Development do pull request GitHub. Estes links estão disponíveis apenas quando usados AB# na descrição do pull request. Eles não aparecem se ligares diretamente ao pull request a partir do item de trabalho. Remover a AB# referência da descrição também a remove da secção de Desenvolvimento.

Captura de ecrã dos links AB# na secção de desenvolvimento do GitHub pull request.

Criar ramo GitHub a partir do item de trabalho

Para criar um ramo do GitHub diretamente a partir de um item de trabalho, use os seguintes passos:

  1. No seu quadro, encontra o item de trabalho que queres usar para criar um branch no GitHub.

  2. Selecione Ações de item de trabalho>Novo ramo GitHub.

    Captura de ecrã do item de trabalho Mais ações selecionadas e destacadas Nova opção GitHub ramificação.

  3. No diálogo Criar um ramo GitHub, insira o nome do ramo. Selecione o repositório GitHub e a ramificação base.

  4. Selecione Criar.

    Captura de ecrã do diálogo Criar uma GitHub Branch.

    O Azure Boards cria o ramo no repositório GitHub especificado e liga-o ao item de trabalho. Para mais informações, consulte Azure Boards-GitHub integração.

  1. Abre o teu item de trabalho e dirige-te à área de Desenvolvimento .

  2. Selecione Adicionar link. Em cada menu suspenso, selecione o seu tipo de link, repositório do GitHub e pull request do GitHub. Podes pesquisar e aprofundar dentro do repositório para encontrar e selecionar um pull request ou commit específico, sem precisar de copiar e colar um URL.

  3. Selecione Adicionar link.

    Captura de ecrã mostrando uma sequência de cinco passos para adicionar um link de pull request ao item de trabalho.

    O Azure Boards verifica para garantir que introduziu um link válido. O repositório GitHub ligado deve estar ligado ao projeto Azure Boards caso contrário a validação falha.

Note

Se estiver a usar o Azure DevOps Server e o GitHub Enterprise Server, existe um atraso ao completar os links AB#. O processo utiliza um design de 'push-and-pull' para buscar dos eventos do GitHub as alterações incrementais em Commit, PR e Issue a cada hora.

Vários eventos atualizam automaticamente os links no formulário do item de trabalho, por isso não precisa de os criar manualmente. Estes eventos incluem:

Evento GitHub Action
Ligação ao ramo Quando um pull request é criado a partir de um ramo, liga-se automaticamente ao item de trabalho.
Confirmação de mesclagem Após a fusão do pull request, o commit resultante liga-se automaticamente ao item de trabalho.
Excluir ramificação Se a ramificação for excluída (normalmente após a mesclagem), seu link será removido automaticamente do item de trabalho.

A secção de Desenvolvimento no formulário do item de trabalho lista os links criados para GitHub commits e pull requests usando o ícone GitHub.

Captura de ecrã do formulário do item de trabalho, a secção de Desenvolvimento mostra GitHub links.

Selecione o link para abrir o commit ou pull request no GitHub.

Informações sobre pedidos de pull no GitHub

Os pull requests ligados do GitHub na secção de Desenvolvimento mostram detalhes extra de estado, para que possa avaliar o progresso sem abrir o pull request no GitHub.

Pré-requisitos para análises de pull requests

Para ver informações detalhadas de pull request, vá para a aplicação Azure Boards em GitHub e aceite as permissões atualizadas para leitura e escrita aos Checks.

Captura de ecrã do diálogo de permissões da aplicação Azure Boards GitHub a mostrar as permissões atualizadas de verificação.

Ver detalhes do estado do pull request

  1. Abra um item de trabalho que tenha um pull request ligado ao GitHub.

  2. Na secção Desenvolvimento, encontre o pull request associado. Os seguintes detalhes de estado aparecem ao lado do link do pull request:

    • Estado do rascunho: Mostra se o pull request ainda é um rascunho.
    • Estado da avaliação: Mostra se o pull request precisa de ser revisto, se foi aprovado ou se tem alterações solicitadas.
    • Estado das verificações: Mostra se as verificações de CI estão a passar, a falhar ou pendentes.

    Captura de ecrã da secção de Desenvolvimento mostrando um pull request de GitHub ligado com indicadores de detalhe de encerramento, revisão e estado de verificação.

  3. Passe o rato sobre um indicador de estado para ver mais detalhes, ou selecione o link pull request para o abrir diretamente no GitHub.

Mencione GitHub pull requests usando !

Use as menções ! para referenciar e discutir GitHub pull requests diretamente de qualquer item de trabalho, campo de texto enriquecido ou comentário de discussão. Quando escreve ! num campo de texto, aparece um seletor que pode usar para procurar e selecionar um pull request GitHub de um repositório ligado. O pull request selecionado é inserido como um link clicável.

Esta funcionalidade facilita a referência a pull requests relacionados em descrições de itens de trabalho, critérios de aceitação ou tópicos de discussão sem copiar manualmente URLs.

Gif a mostrar como usar a menção '!' para referenciar um pedido de pull do GitHub numa discussão sobre o item de trabalho.

Visualizar o estado da compilação de pipelines YAML (Integrado na build)

Quando utilizas Azure Pipelines YAML para compilar código alojado num repositório GitHub, podes criar automaticamente ligações Integrado na construção em itens de trabalho associados. Esta funcionalidade proporciona rastreabilidade de compilação para repositórios do GitHub, alcançando paridade com a experiência disponível para Azure Repos.

Para ativar esta caraterística:

  1. Abre o teu pipeline YAML, seleciona Mais ações e depois seleciona Definições.

  2. No diálogo de definições do pipeline , ativa a ligação automática de novos itens de trabalho nesta build.

    Captura de ecrã do diálogo de definições do pipeline YAML a mostrar a opção Ligar automaticamente novos itens de trabalho nesta opção de compilação.

Quando a build termina, um link Integrated in build aparece automaticamente na secção de Desenvolvimento de cada item de trabalho associado, proporcionando à sua equipa total rastreabilidade do item de trabalho para a build.

Captura de ecrã do item de trabalho a mostrar o link Integrated in Build na secção de Desenvolvimento.

Para mais informações sobre como configurar esta definição, consulte Configurar pipelines para suportar o acompanhamento de trabalho.

Ver objetos do GitHub num quadro

Ao ativar as anotações do GitHub no quadro, pode abrir rapidamente commits, pull requests ou issues do GitHub ligados para mais detalhes. Para obter mais informações, consulte Personalizar cartões.

Captura de ecrã do quadro que mostra links do GitHub nos cartões de itens de trabalho.

Próximos passos

Configurar selos de status

Conteúdo relacionado

  • Last updated on