Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022
Neste artigo, saiba como vincular itens de trabalho a confirmações GitHub, solicitações de pull, branches e builds depois de conectar seu projeto Azure Boards a um repositório GitHub. Você pode usar a sintaxe #mention para commits e branches, usar menções ! para fazer referência a pull requests do GitHub a partir das discussões de itens de trabalho ou adicionar um link de commit, pull request ou branch do GitHub diretamente a partir do item de trabalho no Azure Boards.
Note
GitHub integration support:
- Azure DevOps Services: integra-se com repositórios GitHub.com e GitHub Enterprise Server por meio do aplicativo Azure Boards para GitHub.
- Azure DevOps Server 2020 e posterior: Suporta apenas a integração com repositórios do GitHub Enterprise Server.
- Outros repositórios Git: não há suporte para integração.
Prerequisites
| Category | Requirements |
|---|---|
| Permissões | Contributor ao projeto Azure Boards e ao repositório GitHub. |
| Conexão de projeto | O projeto Azure Boards está conectado ao repositório GitHub em que os commits, as solicitações de pull e o branch que você deseja vincular ou dos quais deseja existir. Para obter mais informações, consulte Azure Boards-GitHub integration. |
Note
Para exibir a seção Desenvolvimento e os tipos de link do GitHub, os projetos que usam o modelo de processo XML hospedado precisam de atualizações nos tipos de item de trabalho. Para obter mais informações, consulte Atualizar definições XML para selecionar tipos de item de trabalho.
Usar AB# para vincular de GitHub a itens de trabalho Azure Boards
Em um commit do GitHub, pull request ou issue, use a sintaxe a seguir para criar um link para seu item de trabalho no 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 de estado não for reconhecido diretamente, Azure Boards tentará correspondê-lo 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, itens de trabalho referenciados com fix, fixes, ou fixed transição 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 nos backlogs e quadros 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 itens de trabalho do Azure Boards 123, 124 e 126. 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 itens de trabalho nos Azure Boards 123, 124 e 126. 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 |
Links para o GitHub issue #123 e Azure Boards work item 234. Nenhuma transição é feita. |
Note
Se você conectou o mesmo repositório GitHub a projetos definidos em duas ou mais organizações Azure DevOps, poderá ver links de referência inesperados 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 Azure DevOps.
Quando você adiciona um link a um item de trabalho usando AB# em uma descrição de solicitação pull, esses links aparecem na seção Development da solicitação de pull GitHub. Esses links só estão disponíveis quando você usa AB# na descrição da solicitação de pull. Elas não aparecerão se você vincular o pull request diretamente a partir do item de trabalho. Remover a AB# referência da descrição também a remove da seção Desenvolvimento.
Criar GitHub branch a partir do item de trabalho
Para criar um branch GitHub diretamente de um item de trabalho, use as seguintes etapas:
No seu quadro, localize o item de trabalho que você deseja usar para criar um branch do GitHub.
Selecione
Ações de item de trabalho>Nova ramificação do GitHub.
Na caixa de diálogo Criar uma GitHub branch, insira o nome do branch. Selecione o repositório GitHub e o branch base.
Selecione Criar.
Azure Boards cria o branch no repositório de GitHub especificado e o vincula ao item de trabalho. Para obter mais informações, consulte Azure Boards-GitHub integration.
Adicionar link de item de trabalho a branch, commit ou pull request no GitHub
Abra o item de trabalho e vá para a área desenvolvimento .
Selecione Adicionar link. Em cada menu suspenso, selecione o tipo de link, o repositório do GitHub e o pull request do GitHub. Você pode pesquisar e fazer drill down no repositório para localizar e selecionar uma solicitação de pull ou confirmação específica, sem a necessidade de copiar e colar uma URL.
Selecione Adicionar link.
Azure Boards verifica se você inseriu um link válido. O repositório vinculado a GitHub deve ser conectado ao projeto Azure Boards ou a validação falhará.
Note
Se você estiver usando Azure DevOps Server e GitHub Enterprise Server, há um atraso ao concluir os links AB#. O processo usa um design "push-and-pull" para extrair eventos do GitHub a cada hora, sobre as alterações incrementais em Commit, PR e Issue.
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. Esses eventos incluem:
| evento GitHub | Action |
|---|---|
| Linkar 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 o pull request é mesclado, o merge commit resultante é automaticamente vinculado 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 commits e pull requests do GitHub por meio do ícone
GitHub.
Selecione o link para abrir a solicitação de confirmação ou pull no GitHub.
Insights de pull request do GitHub
As solicitações de pull de GitHub vinculadas na seção Desenvolvimento mostram detalhes de status extras, para que você possa avaliar o progresso sem abrir a solicitação de pull no GitHub.
Pré-requisitos para análises de pull request
Para ver os insights de pull request, acesse o aplicativo Azure Boards no GitHub e aceite as permissões atualizadas para acesso de leitura e gravação em Verificações.
Exibir detalhes de status da solicitação de pull
Abra um item de trabalho que tenha uma solicitação de pull GitHub vinculada.
Na seção Desenvolvimento , localize a solicitação de pull vinculada. Os seguintes detalhes de status aparecem ao lado do link de solicitação de pull:
- Status do rascunho: mostra se a solicitação de pull ainda é um rascunho.
- Status da revisão: mostra se a solicitação de pull precisa de revisão, foi aprovada ou tem alterações solicitadas.
- Verifica o status: mostra se as verificações de CI estão passando, falhando ou pendentes.
Passe o mouse sobre um indicador de status para ver mais detalhes ou selecione o link de solicitação de pull para abri-lo diretamente no GitHub.
Mencione pull requests do GitHub usando !
Use ! menções para referenciar e discutir pull requests do GitHub diretamente de qualquer campo rich-text de item de trabalho ou comentário de discussão. Quando você digita ! em um campo de texto, um seletor é exibido que você pode usar para pesquisar e selecionar uma solicitação de pull GitHub de um repositório conectado. A solicitação de pull selecionada é inserida como um link clicável.
Esse recurso facilita a referência a solicitações de pull relacionadas em descrições de item de trabalho, critérios de aceitação ou threads de discussão sem copiar manualmente URLs.
Gif mostrando como usar a menção ! para fazer referência a um pull request do GitHub em uma discussão de item de trabalho.
Exibir o status do build para pipelines YAML (integrado ao build)
Ao usar Azure Pipelines YAML para criar código hospedado em um repositório do GitHub, você pode criar automaticamente links de build integrados em itens de trabalho associados. Esse recurso fornece rastreabilidade de build para repositórios GitHub, alcançando paridade com a experiência disponível para "Azure Repos".
Para habilitar este recurso:
Abra o pipeline do YAML, selecione
Mais ações e selecione Configurações.Na caixa de diálogo Configurações do Pipeline , habilite a vinculação automática de novos itens de trabalho neste build.
Quando a compilação for concluída, um link Integrado ao build será exibido automaticamente na seção Desenvolvimento de cada item de trabalho associado, fornecendo à sua equipe total rastreabilidade do item de trabalho para o build.
Para obter mais informações sobre como definir essa configuração, consulte Configurar pipelines para dar suporte ao acompanhamento de trabalho.
Exibir objetos GitHub em uma placa
Ao habilitar as anotações do GitHub no quadro, você pode abrir rapidamente commits vinculados, pull requests ou issues do GitHub para obter mais detalhes. Para obter mais informações, confira Personalizar cartões.
Próximas etapas
Conteúdo relacionado
- Integrate Azure Boards com GitHub
- Configurar pipelines para dar suporte ao acompanhamento de trabalho
- Entenda como os estados de categoria de fluxo de trabalho são usados em listas de pendências e quadros do Azure Boards
- Vincular itens de trabalho a objetos
- Solucionar problemas de integração do GitHub e Azure Boards