Instalar o aplicativo Azure Boards para GitHub

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

Nesta introdução, instala-se o aplicativo Azure Boards para o GitHub, conectando o Azure Boards aos seus repositórios no GitHub. Ao conectar Azure Boards projetos com repositórios de GitHub.com, você dá suporte à vinculação entre confirmações de GitHub e solicitações de pull para itens de trabalho. Você pode usar GitHub para desenvolvimento de software ao usar Azure Boards para planejar e acompanhar seu trabalho. Depois de instalar o aplicativo Azure Boards para GitHub na sua conta ou organização do GitHub, escolha quais repositórios do GitHub você deseja conectar ao projeto.

Para obter uma visão geral da integração que o aplicativo Azure Boards para GitHub dá suporte, consulte Azure Boards-GitHub integration.

Prerequisites

Categoria de permissão Requirements
Azure DevOps - Membro do grupo Administradores de Coleção de Projetos. Se você criou o projeto, terá essa permissão.
- Membro do projeto no projeto do Azure Boards.
GitHub - Administrador ou proprietário da organização GitHub para instalar o aplicativo Azure Boards
- Permissões de leitura para o repositório GitHub

Important

  • Se o repositório já estiver conectado usando outro tipo de autenticação, como o OAuth, você deverá remover esse repositório da conexão existente antes de reconectá-lo usando o aplicativo GitHub. Siga as etapas fornecidas em Adicionar ou remover repositórios do GitHub posteriormente neste artigo antes de configurar o App GitHub.
  • Você pode conectar uma organização Azure DevOps a vários repositórios de GitHub se você for um administrador desses repositórios. Você não deve conectar um repositório do GitHub a mais de uma organização do Azure DevOps.

Instalar e configurar o aplicativo Azure Boards

As etapas a seguir mostram uma sequência de instalação típica. Siga todos os prompts na tela para concluir a instalação.

  1. Acesse o aplicativo Azure Boards no GitHub Marketplace.

  2. Em Planos e preços, em Gratuito, selecione Instalar.

  3. In Install & Autorize Azure Boards, escolha os repositórios aos quais deseja se conectar Azure Boards e selecione Instalar & Autorizar.

    Este exemplo usa todos os repositórios:

    A captura de tela mostra a página Instalar e Autorizar com todos os repositórios selecionados.

  4. Escolha a organização do Azure DevOps e o projeto Azure Boards aos quais você deseja se conectar ao GitHub.com.

    Screenshot mostra a página Configurar seu projeto Azure Boards em que você seleciona uma organização e um project.

    Você pode conectar somente um projeto por vez. Se você quiser conectar outros projetos, consulte Configurar outros projetos ou repositórios.

Conceder acesso à organização Azure Boards

Para conceder acesso GitHub à sua organização Azure DevOps, conclua as etapas a seguir.

  1. No portal da web do GitHub, abra Configurações no menu de perfil.

    A captura de tela mostra a opção Configurações em seu perfil.

  2. Selecione Aplicativos em Integrações.

  3. Selecione Authorized GitHub Apps>Azure Boards.

    Captura de tela mostra aplicativos do GitHub autorizados com o Azure Boards destacado.

  4. Em Acesso à organização, resolva possíveis problemas que possam aparecer. Selecione Conceder para conceder acesso a todas as organizações que aparecem com uma solicitação de Acesso pendente.

    Captura de tela mostra o acesso à organização com organizações sem acesso.

Verifique sua política de acesso a aplicativos de terceiros

Verifique se sua organização GitHub permite acesso a aplicativos de terceiros para o aplicativo Azure Boards. Se o acesso de terceiros for restrito, a adição de repositórios de Azure DevOps poderá mostrar uma lista vazia ou produzir um erro.

Para habilitar o acesso:

  1. No GitHub, acesse sua organização e vá para Settings>política de aplicativo OAuth.

  2. Aprove o aplicativo Azure Boards especificamente (recomendado) ou remova as restrições para todos os aplicativos de terceiros.

    A captura de tela mostra a política de acesso de aplicativos de terceiros.

Observação

Você deve ser um proprietário ou administrador da organização para alterar essa configuração.

Depois de configurar a integração entre o Azure Boards e o GitHub, você pode vincular seus itens de trabalho a pull requests e commits do GitHub.

O exemplo a seguir demonstra a integração criando um item de trabalho e vinculando-o a uma solicitação de pull:

  1. Em seu quadro, selecione Novo item de trabalho para criar um item de trabalho. Para este exemplo, use o título "Adicionar selo ao README". O tipo de item de trabalho depende do processo: Problema (Básico), História do Usuário (Agile) ou Item de Backlog do Produto (Scrum).

    O novo item de trabalho aparece no seu quadro.

  2. Abra seu item de trabalho e vá para a seção Desenvolvimento .

  3. Selecione Adicionar link e, em seguida, selecione GitHub Pull Request no menu Tipo de link.

  4. Selecione o repositório e insira a ID da solicitação de pull. Você também pode adicionar um comentário opcional.

  5. Selecione Adicionar link para criar a conexão.

    Azure Boards executa automaticamente as seguintes ações em segundo plano:

    • Adiciona um selo ao arquivo README do primeiro repositório na lista de repositórios GitHub conectados
    • Cria uma confirmação de GitHub para a atualização de selo
    • Cria uma solicitação de pull GitHub para mesclar as alterações no arquivo README
    • Vincula a solicitação de confirmação e pull do GitHub ao item de trabalho

  6. No item de trabalho, selecione o link de solicitação de pull para abri-lo no GitHub.

  7. Selecione Mesclar solicitação de pull no GitHub.

  8. No repositório GitHub, abra o arquivo README para verificar se o selo foi adicionado. Para obter mais informações, consulte Configurar selos de status para adicionar a arquivos README do GitHub.

Configurar outros projetos ou repositórios

Você pode configurar outros projetos Azure Boards/Azure DevOps, GitHub.com repositórios ou alterar a configuração atual da página do aplicativo Azure Boards. ** Para obter mais informações, consulte Adicionar ou remover repositórios, ou remova uma conexão dos Azure Boards.

Adicionar ou remover repositórios ou remover uma conexão de Azure Boards

Se você encontrar um problema com uma conexão, remova a conexão e comece novamente com uma nova conexão.

  1. No seu projeto no Azure DevOps, selecione Configurações do projeto>Conexões do GitHub.

  2. Para adicionar ou remover repositórios, selecione Mais opções para a conexão e escolha Adicionar repositórios ou Remover repositórios no menu.

    Captura de tela mostra o menu Mais opções de conexão do GitHub.

  3. Para remover todos os repositórios e a conexão, escolha a opção Remover conexão. Em seguida, escolha Remover para confirmar.

    Captura de tela mostra a remoção de confirmação da conexão do GitHub.

Alterar o acesso ao repositório

  1. No portal da web do GitHub, abra Configurações no menu de perfil.

  2. SelecioneIntegrações>Aplicativos. Em Aplicativos GitHub Instalados, selecione Configurar.

    Screenshot mostra os Aplicativos GitHub Instalados com Azure Boards e a opção Configurar.

    A página de configuração do Azure Boards é aberta.

  3. Role para baixo até a seção Acesso ao Repositório.

  4. Escolha a opção desejada, Todos os repositórios ou Somente repositórios selecionados.

    Se você escolher Selecionar apenas repositórios, selecione os repositórios que deseja integrar com o Azure Boards.

    A captura de tela mostra o acesso ao Repositório, onde você pode escolher repositórios selecionados.

  5. Clique em Salvar.

Suspender ou desinstalar a integração de Azure Boards

  1. Começando na etapa 2 do procedimento anterior, role para baixo até a seção Zona de perigo.

    A captura de tela mostra a seção Zona perigo, com opções para suspender e desinstalar.

  2. Para suspender a integração, selecione Suspender. Na janela de confirmação, selecione OK para confirmar a suspensão.

    A captura de tela mostra a caixa de diálogo de confirmação de suspensão.

    Para reativar a integração, selecione Unsuspend.

  3. Para desinstalar o aplicativo Azure Boards, selecione Desinstalar e selecione OK na janela de confirmação pop-up.

    A captura de tela mostra a caixa de diálogo de confirmação de desinstalação.

Atualizar conexões entre o Azure Boards e o GitHub

Se você alterar os repositórios aos quais o aplicativo Azure Boards para GitHub dá suporte, você poderá ser redirecionado para Azure Boards GitHub conexões. Uma boa prática é remover os repositórios em Azure Boards que não podem mais se conectar a GitHub. Para obter mais informações, consulte Adicionar ou remover repositórios do GitHub.

Se você desinstalar o aplicativo Azure Boards para GitHub, a mensagem a seguir será exibida em Azure Boards, Configurações do projeto>GitHub conexões. Selecione Remover conexão para remover todas as conexões GitHub feitas anteriormente. Para obter mais informações, consulte Adicionar ou remover repositórios do GitHub.

Screenshot mostra um aplicativo do GitHub do Azure Boards desinstalado.

Solucionar problemas de integração

Lista de repositórios vazia ao adicionar repositórios

Se a lista de repositórios aparecer vazia no Azure DevOps:

Estado travado "Solicitação de acesso pendente"

Se o acesso à organização permanecer pendente:

  • Você deve ser um GitHub proprietário ou administrador da organização para aprovar a solicitação.
  • Selecione Concessão na seção de acesso da organização das configurações de aplicativos autorizados.
  • Se o problema persistir, desinstale o aplicativo Azure Boards e reinstale-o seguindo as etapas em Instalar e configurar o aplicativo Azure Boards.

O selo não aparece após vincular a solicitação de pull

Se o selo não aparecer no arquivo README depois de vincular uma solicitação de pull:

  • O selo só aparece quando você vincula a solicitação de pull e o repositório é o primeiro da lista conectada.
  • Verifique se a PR que você vinculou ainda está aberta (PRs mescladas não acionam a criação do selo).
  • Verifique se o Azure Boards tem acesso de gravação ao seu repositório.

Erros de autenticação ou permissões

Se você vir erros de autenticação durante a instalação:

  • Verifique se você é um proprietário ou administrador da organização no GitHub.
  • Verifique se sua organização GitHub não restringiu o acesso a aplicativos de terceiros.
  • Verifique se você tem permissões de leitura no repositório que deseja conectar.
  • Tente sair do GitHub, fazer login novamente e, em seguida, tentar autorizar novamente.

Próxima etapa

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

Conteúdo relacionado

  • Last updated on