Azure Repos com Slack

  • Artigo

Azure DevOps Services

Se você usar o Slack, poderá usar o aplicativo Azure Repos do Slack para monitorar facilmente seus repositórios do Azure Repos. Configure e gerencie assinaturas para receber notificações no canal sempre que o código for enviado ou verificado e sempre que uma solicitação pull (PR) for criada, atualizada ou mesclada. Esse aplicativo dá suporte a eventos do Git e do Controle de Versão do Team Foundation (TFVC).

Pré-requisitos

Observação

  • Você só pode vincular o aplicativo Azure Repos para Slack a um projeto hospedado no Azure DevOps Services no momento.
  • No momento, não há suporte para notificações dentro de mensagens diretas.

Adicionar o aplicativo Azure Repos ao workspace do Slack

  1. Vá para o aplicativo Azure Repos Slack e selecione Adicionar ao Slack.

    Captura de tela do diretório do aplicativo Slack, do Azure Repos e do botão Adicionar ao Slack.

    Após a adição, é exibida uma mensagem de boas-vindas semelhante a esta.

    Captura de tela da mensagem de boas-vindas do Slack.

  2. Use o identificador do /azrepos Slack para interagir com o aplicativo. Uma lista completa de comandos é fornecida na seção de referência ao comando deste artigo.

Conectar o aplicativo Azure Repos aos seus repositórios

  1. Conecte-se e autentique-se no Azure Repos usando o comando /azrepos signin.

    Captura de tela do prompt de login do Slack.

  2. Selecione Entrar.

  3. Aceite a integração do Azure Repos Slack.

    Captura de tela do botão Aceitar na tela de login resultante.

    Um código de verificação é exibido para uso no aplicativo de bate-papo para concluir a autenticação.

  4. Copie o código de autenticação.

    Captura de tela do código de verificação fornecido pelo Azure Repos.

  5. Selecione Inserir código, cole o código e selecione Enviar.

    Captura da tela de autenticação final quando o código de verificação é colado e, em seguida, o botão de envio é selecionado.

    A confirmação de login é exibida no bate-papo.

    Captura de tela da confirmação de login no bate-papo.

Para começar a monitorar todos os repositórios Git em um projeto, use o seguinte comando de barra dentro de um canal:

/azrepos subscribe [project url]

A URL do projeto pode estar em qualquer página do projeto (exceto URLs para repositórios). Por exemplo:

/azrepos subscribe https://dev.azure.com/myorg/myproject/

Você também pode monitorar um repositório específico usando o seguinte comando:

/azrepos subscribe [repository url]

A URL do repositório pode estar em qualquer página no repositório que tenha o nome do repositório. Por exemplo, para repositórios Git, use:

/azrepos subscribe https://dev.azure.com/myorg/myproject/_git/myrepository

Para repositórios TFVC, use:

/azrepos subscribe https://dev.azure.com/myorg/myproject/_versionControl

Observação

Você só pode se inscrever em repositórios públicos.

O comando de assinatura é iniciado com uma assinatura padrão. Para repositórios do Git, o canal é inscrito no evento Solicitação de pull criada (com branch de destino = principal) e, para repositórios do TFVC, o canal é assinado para o evento Código verificado.

Captura de tela mostrando a mensagem de criação de assinaturas padrão.

Gerenciar Assinaturas

Para exibir, adicionar ou remover assinaturas de um canal, use o seguinte comando subscriptions:

/azrepos subscriptions

Esse comando lista todas as assinaturas atuais do canal e permite que você adicione novas assinaturas ou remova as existentes. Ao adicionar assinaturas, você pode personalizar as notificações recebidas usando vários filtros, conforme descrito na seção a seguir.

Observação

Os administradores de equipe não podem remover ou modificar assinaturas criadas pelos administradores do Projeto.

Captura de tela mostrando a opção Exibir da lista de assinaturas.

Usar filtros para personalizar assinaturas

Quando um usuário assina um repositório usando o comando /azrepos subscribe, uma assinatura padrão é criada. Muitas vezes, os usuários precisam personalizar essas assinaturas. Por exemplo, os usuários podem querer ser notificados somente quando as PRs tiverem um revisor específico.

As etapas a seguir demonstram como personalizar assinaturas.

  1. Execute o comando /azrepos subscriptions.
  2. Na lista de assinaturas, se houver uma assinatura indesejada ou que precise ser modificada (Exemplo: criar ruído no canal), selecione o botão Remover.
  3. Selecione o botão Adicionar assinatura.
  4. Selecione o repositório necessário e o evento desejado.
  5. Selecione os filtros apropriados.

Exemplo: obter notificações somente quando minha equipe estiver na lista de revisor de uma PR

Captura de tela mostrando que o Revisor tem minha equipe.

Exemplo: diga-me quando as tentativas de mesclagem falham devido a uma violação de política

Captura de tela mostrando a tentativa de mesclagem malsucedida devido à violação da política.

Observação

  • Normalmente, todos os filtros são suspensos. No entanto, se a lista suspensa tiver mais de 100 itens, os usuários deverão inserir os valores manualmente.
  • Para o código TFVC verificado no evento, o filtro Em caminho deve ser do formato $/myproject/path.

Visualizar URLs de solicitação de pull

Quando um usuário colar a URL de uma PR, uma visualização será exibida como a imagem a seguir, o que ajuda a manter as conversas relacionadas a PR contextuais e precisas.

Captura de tela mostrando o desenrolamento da URL.

Depois que os usuários fazem login, esse recurso funciona para todos os canais em um espaço de trabalho.

Remover assinaturas e repositórios de um canal

Use o comando a seguir para limpar o canal removendo repositórios e assinaturas.

/azrepos unsubscribe all [project url]

Por exemplo, o comando a seguir exclui todas as assinaturas relacionadas a qualquer repositório no projeto e remove os repositórios do canal. Somente os administradores do projeto podem executar esse comando.

/azrepos unsubscribe all https://dev.azure.com/myorg/myproject

Referência do comando

A tabela a seguir lista tudo o que /azrepos commands você pode usar em seu canal do Slack.

Comando barra Funcionalidade
/azrepos subscribe [repository url/ project url] Inscrever-se em um repositório ou em todos os repositórios em um projeto para receber notificações
/azrepos subscriptions Adicione ou remova as assinaturas para este canal
/azrepos signin Entre em sua organização do Azure Repos
/azrepos signout Sair da sua organização do Azure Repos
/azrepos feedback Relatar um problema ou sugerir um recurso
/azrepos unsubscribe all [project url] Remover todos os repositórios (pertencentes a um projeto) e suas assinaturas associadas de um canal

Notificações em canais privados

O aplicativo Azure Repos também pode ajudar a monitorar os eventos do repositório em seus canais privados. Convide o bot para seu canal privado usando /invite @azrepos. Em seguida, você pode gerenciar suas notificações da mesma forma que faria para um canal público.

Solucionar problemas

Se você estiver enfrentando os seguintes erros ao usar o aplicativo Azure Repos para Slack, siga os procedimentos nesta seção.

Algo deu errado. Tente novamente.

O aplicativo Azure Repos usa o protocolo de autenticação OAuth e requer o acesso de aplicativos de terceiros por meio do OAuth para que a organização seja habilitada. Para habilitar essa configuração, navegue até Políticas de Segurança >de Configurações>da Organização e defina o acesso de aplicativos de terceiros por meio do OAuth para a configuração da organização como Ativada.

Habilitar o acesso de aplicativos de terceiros por meio do OAuth para a configuração da organização

Falha na configuração. Verifique se a organização '{organization name}' existe e se você tem permissões suficientes.

Saia do Azure DevOps navegando para https://aka.ms/VsSignout usar seu navegador.

Abra uma janela do navegador em Anônimo ou anônimo e navegue até https://aex.dev.azure.com/me e entre. Na lista suspensa, no ícone de perfil à esquerda, selecione o diretório que contém a organização que contém o repositório ao qual você deseja assinar.

Selecione o diretório que contém a organização que contém o projeto

No mesmo navegador, inicie uma nova guia, navegue até https://slack.come entre no workspace (use o clienteWeb). Execute o /azrepos signout comando seguido pelo /azrepos signin comando.

Selecione o Sign in botão e você será redirecionado para uma página de consentimento como a do exemplo a seguir. Verifique se o diretório mostrado ao lado do e-mail é o mesmo que foi escolhido na etapa anterior. Aceite e conclua o processo de entrada.

Captura de tela mostrando o Consentimento para as permissões de aplicativo solicitadas.

Se essas etapas não resolverem o problema de autenticação, entre em contato conosco na Comunidade de Desenvolvedores.