Instalar o aplicativo Azure Boards para GitHub

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Instale o aplicativo Azure Boards para GitHub para conectar o Azure Boards a seus repositórios do GitHub. Ao conectar projetos do Azure Boards com repositórios GitHub.com, você dá suporte à conexão entre confirmações do GitHub e solicitações pull para itens de trabalho. Você pode usar o GitHub para desenvolvimento de software enquanto usa o Azure Boards para planejar e acompanhar seu trabalho.

Para obter uma visão geral da integração compatível com o aplicativo Azure Boards para GitHub, confira Integração entre o Azure Boards e o GitHub. Depois de instalar o aplicativo Azure Boards para GitHub na sua conta ou organização do GitHub, escolha a quais repositórios do GitHub você quer conectar a partir do seu projeto.

Pré-requisitos

  • Para instalar o aplicativo Azure Boards, você deve ser um administrador ou proprietário do repositório do GitHub.
  • Para conectar ao projeto Azure Boards, você deve ter permissões de Leitura para o repositório do GitHub. Você também precisa ser membro do grupo Administradores de coleção de projetos. Se você criou o projeto, terá as permissões.

Importante

Se o repositório já estiver conectado por meio de outro tipo de autenticação, como OAuth, você deverá remover esse repositório da conexão existente antes de reconectá-lo ao aplicativo GitHub. Siga as instruções em Adicionar ou remover repositórios do GitHub, mais adiante neste artigo, antes de configurar o aplicativo GitHub.

Se for administrador desses repositórios, você pode conectar uma organização do Azure DevOps a diversos repositórios do GitHub. Mas você não deve conectar um repositório do GitHub a mais de uma organização do Azure DevOps.

Conceder acesso à organização Azure Boards

Siga os passos a seguir para conceder acesso à organização.

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

    Screenshot of open profile, choose Settings.

  2. Selecione Aplicativos em Integrações.

  3. Selecione Aplicativos OAuth Autorizados>Azure Boards.

    Screenshot of Authorized OAuth Apps tab, choose Azure Boards.

  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.

    Screenshot of Organization access with organizations without access.

Instalar e configurar o aplicativo Azure Boards

  1. Vá para o aplicativo Azure Boards no GitHub Marketplace.

  2. Selecione Configurar um plano.

    Screenshot of GitHub Marketplace, Set up a plan button.

  3. Escolha a organização do GitHub à qual você deseja conectar o Azure Boards.

    Screenshot showing Install Azure Boards dialog.

  4. Escolha os repositórios que você quer conectar aos Azure Boards.

    No exemplo a seguir, optamos por conectar a todos os repositórios.

    Screenshot showing all repositories selected.

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

    Screenshot of setting up connection dialog.

    Você pode exportar somente um projeto por vez. Se você quiser conectar outros projetos, poderá fazer isso depois, como descrito em Configurar outros projetos ou repositórios posteriormente neste artigo.

  6. Autorize sua organização no Azure Boards a se conectar ao GitHub.com.

    Screenshot of Azure Boards authorization dialog.

  7. Confirme os repositórios do GitHub.com que você deseja conectar. Selecione cada repositório ao qual você deseja se conectar. Desmarque todos os repositórios que você não deseja que participem da integração.

    Screenshot of Confirm your GitHub repositories dialog.

Usar a conexão

Neste ponto, sua integração do Azure Boards com o GitHub do Azure está concluída. Você pode ignorar os próximos passos ou segui-los para entender os recursos compatíveis com a conexão.

  1. No seu quadro, selecione Novo item para inserir um novo item de trabalho chamado "Adicionar notificação ao LEIAME", Problema (Básico), Histórico do Usuário (Agile) ou Item de Backlog do Produto (Scrum), dependendo do modelo de processo usado pelo seu projeto do Azure Boards.

    Um item de trabalho intitulado Adicionar notificação ao LEIAME aparece no quadro.

  2. Abra seu item de trabalho e selecione solicitação de pull em Adicionar link.

  3. Selecione o repositório e insira o ID da solicitação de pull e um comentário opcional.

  4. Selecione Adicionar link.

    Screenshot of Add link action in user story, showing repository selection and empty boxes for input of pull request ID and optional comment.

    As seguintes ações ocorrem no segundo plano.

    • Adiciona uma notificação ao arquivo LEIAME do primeiro repositório na lista de repositórios do GitHub conectados.
    • Cria uma confirmação do GitHub para a atualização feita ao adicionar a notificação ao arquivo LEIAME.
    • Cria uma solicitação de pull do GitHub para mesclar as alterações feitas ao arquivo LEIAME.
    • Vincula a solicitação de pull e o commit do GitHub ao item de trabalho criado na etapa 1.
  5. Selecione o primeiro link de solicitação de pull do seu item de trabalho.

    Screenshot of issue form for pull request opened in GitHub.

    A solicitação de pull do GitHub é aberta em uma nova guia do navegador.

  6. Selecione Mesclar solicitação de pull.

    Screenshot of example pull request in GitHub.

  7. Vá ao arquivo LEIAME do repositório e veja a notificação que foi adicionada.

    Screenshot of GitHub repo with badge added.

    Para obter mais informações, consulte Configurar notificações de status para adicionar a arquivos LEIAME do GitHub.

Configurar outros projetos ou repositórios

Você pode configurar outros projetos do Azure Boards/Azure DevOps Projects, repositórios do GitHub.com ou alterar a configuração atual na página do aplicativo Azure Boards. Confira mais informações em Alterar acesso ao repositório do GitHub ou suspender ou desinstalar a integração.

Adicionar ou remover repositórios ou remover conexão do Azure Boards

Se houver um problema com uma conexão, recomendamos remover a conexão e recomeçar com uma nova conexão.

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

    Screenshot of GitHub connection menu of More options.

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

    Screenshot of confirmation removal of GitHub connection.

  1. Para adicionar ou remover repositórios, abra o ícone de ações da conexão e escolha Adicionar repositórios ou Remover repositórios no menu.

    Screenshot of add or remove GitHub repos.

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

    Screenshot of confirmation of GitHub connection removal dialog.

Alterar o acesso ao repositório

  1. Entre no portal da Web da sua organização no GitHub e abra Configurações da conta.

    https://github.com/organizations/fabrikam-fiber/settings/profile

  2. Escolha Aplicativos do GitHub Instalados e, em seguida, Configurar ao lado de Azure Boards.
    Screenshot of open Organization account, Installed GitHub Apps, Azure Boards, Configure.

    A página de configurações 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 Somente repositórios selecionados, selecione os repositórios que você deseja que participem da integração com o Azure Boards.

    Screenshot of Repository access, choose Only select repositories.

  5. Selecione Salvar quando terminar.

Suspender ou desinstalar a integração com o Azure Boards

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

    Screenshot of Azure Boards configuration, Danger zone section.

  2. Para suspender a integração, escolha Suspender. Na janela de confirmação pop-up, escolha OK para confirmar a suspensão.

    Screenshot of suspension confirmation.

    Para cancelar a suspensão da integração, escolha Cancelar a suspensão.

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

    Screenshot of uninstall confirmation.

Atualizar as conexões do GitHub com Azure Boards

Se modificar os repositórios compatíveis com o aplicativo Azure Boards para GitHub, você poderá ser redirecionado a conexões GitHub do Azure Boards. Uma boa prática é remover os repositórios no Azure Boards que não podem mais ser conectados ao GitHub. Para obter mais informações, consulte Adicionar ou remover repositórios do GitHub.

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

Screenshot of uninstalled Azure Boards GitHub app.

Próximas etapas