Vincular confirmações, solicitações de pull, branches e problemas do GitHub a itens de trabalho no Azure Boards

Azure DevOps Services | Servidor Azure DevOps | Azure DevOps Server 2022 | Azure DevOps Server 2020

Neste artigo, saiba como vincular itens de trabalho a confirmações, solicitações de pull e branches do GitHub depois de conectar seu projeto do Azure Boards a um repositório do GitHub. Você pode usar a sintaxe #mention para commits e branches ou adicionar uma confirmação do GitHub, solicitação de pull ou link de branch diretamente do item de trabalho do Azure Boards.

Note

Suporte à integração do GitHub:

• Azure DevOps Services: integra-se com repositórios do GitHub.com e do GitHub Enterprise Server por meio do aplicativo Azure Boards para GitHub.
• Azure DevOps Server 2020 e posterior: dá suporte apenas à integração com repositórios do GitHub Enterprise Server.
• Outros repositórios Git: não há suporte para integração.

Prerequisites

Category	Requirements
Permissions	Colaborador ao projeto do Azure Boards e ao repositório GitHub.
Conexão de projeto	O projeto Azure Boards está conectado ao repositório GitHub onde existem os commits, pull requests e branch que você deseja vincular. Para obter mais informações, consulte integração Azure Boards-GitHub.

Note

Os projetos que usam o modelo de processo XML hospedado exigem atualizações dos tipos de item de trabalho para exibir a seção Desenvolvimento e os tipos de link do GitHub. Para obter mais informações, consulte Atualizar definições XML para selecionar tipos de item de trabalho.

Usar AB# para vincular do GitHub aos itens de trabalho do Azure Boards

Em uma confirmação do GitHub, solicitação de pull ou problema, use a sintaxe a seguir para criar um link para o item de trabalho do Azure Boards. Insira o AB#ID dentro do texto de uma mensagem de confirmação. Ou, para uma solicitação de pull ou um issue, insira o AB#ID na descrição. Ao usar AB#ID em um título de comentário ou pull request, não se cria um link no item de trabalho.

AB#{ID}

Por exemplo, AB#125 links para a ID 125 do item de trabalho.

Você também pode inserir uma mensagem de confirmação ou solicitação 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 ao item de menção # que segue.

Quando uma descrição de solicitação de pull inclui um nome de estado válido, por exemplo, Closed AB#1234o sistema atualiza o item de trabalho referenciado para esse estado específico. Se o nome do estado não for reconhecido diretamente, o Azure Boards tentará corresponder a uma categoria de fluxo de trabalho como Resolved ou Completed. Se uma correspondência for encontrada, o item de trabalho fará a transição 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 Resolved. Se nenhum estado desse tipo 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 outros branches, mas as regras de transição de estado não se aplicam a menos que a solicitação de pull seja mesclada no branch padrão.

Para obter mais informações, consulte Como os estados de categoria de fluxo de trabalho são usados ​​em backlogs e painéis do Azure Boards.

Revise a tabela de exemplos a seguir:

Mensagem de solicitação de pull ou confirmação	Action
Fixed AB#123	Vincula e faz a transição do item de trabalho para a categoria de estado do fluxo de trabalho Resolvido ou, se nenhum for definido, a categoria de estado do fluxo de trabalho Concluído.
Closed AB#123	Vincula e faz a transição do item de trabalho para o estado de 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 de estado do fluxo de trabalho Resolvido ou, se nenhum for definido, a categoria de estado do fluxo de trabalho Concluído.
Fixes AB#123, AB#124, and AB#126	Links para os itens de trabalho 123, 124 e 126 do Azure Boards. Faz a transição apenas do primeiro item, 123, para a categoria de estado do fluxo de trabalho Resolvido ou, se nenhum for definido, para a categoria de estado do fluxo de trabalho Concluído.
Fixes AB#123, Fixes AB#124, Fixes AB#125	Links para os itens de trabalho 123, 124 e 126 do Azure Boards. Faz a transição de todos os itens para a categoria de estado do fluxo de trabalho Resolvido ou, se nenhum for definido, para a categoria de estado do fluxo de trabalho Concluído.
Fixing multiple bugs: issue #123 and user story AB#234	Vincula ao problema 123 do GitHub e ao item de trabalho 234 do Azure Boards. Nenhuma transição é feita.

Note

Se você conectou o mesmo repositório GitHub a projetos definidos em duas ou mais organizações do Azure DevOps, poderá ver vinculação inesperada de menção AB#. Para obter mais informações, consulte Resolver problemas de conexão. Por esse motivo, recomendamos que você conecte apenas um repositório GitHub a projetos definidos em uma única organização do Azure DevOps.

Quando você adiciona um link a um item de trabalho usando AB#, esses links aparecem na seção Desenvolvimento da solicitação de pull.

Criar um branch do GitHub a partir do item de trabalho

Para criar um branch do GitHub diretamente de um item de trabalho, siga estas etapas:

1. Em seu quadro, localize o item de trabalho a partir do qual você deseja criar um branch do GitHub.

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

   

3. Na caixa de diálogo Criar um branch do GitHub, insira o nome do branch e selecione o repositório do GitHub e o branch base.

4. Selecione Criar.

   

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

Adicionar link de item de trabalho ao branch, commit ou solicitação de pull do GitHub

1. Abra o item de trabalho e vá para a guia Links.

   

2. Na caixa de diálogo Adicionar link , selecione um dos tipos de link do GitHub, selecione um repositório do GitHub, insira a URL para o branch do GitHub, a confirmação ou a solicitação de pull e selecione Adicionar link.

   No exemplo a seguir, adicionamos um link para uma solicitação de pull do GitHub.

   

   O Azure Boards conclui uma verificação para garantir que você inseriu um link válido. O repositório do GitHub vinculado deve estar conectado ao projeto do Azure Boards ou a validação falhará.

Atualizações automáticas de link

Vários eventos atualizam automaticamente os links no formulário do item de trabalho, portanto, você não precisa criá-los manualmente. Elas incluem:

Evento do GitHub	Action
Vincular ao branch	Quando uma solicitação de pull é criada a partir de uma ramificação, ela é vinculada automaticamente ao item de trabalho.
Confirmação de mesclagem	Depois que a solicitação de pull é mesclada, a confirmação de mesclagem resultante é automaticamente vinculada ao item de trabalho.
Excluir ramo	Se o branch for excluído (normalmente após a mesclagem), seu link será removido automaticamente do item de trabalho.

Exibir ou abrir links da seção Desenvolvimento

A seção Desenvolvimento no formulário de item de trabalho lista os links criados para solicitações de pull e confirmações do GitHub com o ícone do GitHub .

Escolha o link fornecido para abrir a solicitação de pull ou confirmação no GitHub.

Exibir objetos de GitHub em um painel

Com as anotações do GitHub habilitadas no quadro, você pode abrir rapidamente commits, solicitações de pull ou problemas do GitHub vinculados para obter mais detalhes. Para obter mais informações, confira Personalizar cartões.

Próximas etapas

Configurar selos de status

Conteúdo relacionado

• Integrar o Azure Boards com o GitHub
• Entenda como os estados da categoria de fluxo de trabalho são usados nas listas de pendências e quadros do Azure Boards
• Vincular itens de trabalho a objetos
• Solucionar problemas de integração do GitHub e do Azure Boards