Configurar uma política de ramificação para um serviço externo

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

As políticas de branch são um recurso poderoso para garantir o código de alta qualidade em seu repositório estabelecendo requisitos para todas as solicitações de pull. Os serviços externos podem usar a API de Status de PR para postar o status detalhado em suas PRs. A política de branch para serviços adicionais possibilita que esses serviços de terceiros participem do fluxo de trabalho de PR e estabeleçam requisitos de política. Este artigo orienta você ao longo do processo de configuração de uma política de branch para um serviço que está postando status de PR. Para obter mais informações sobre status de PR, consulte Personalizar e estender fluxos de trabalho de solicitação de pull com status de solicitação de pull.

Pré-requisitos

Configurar a política de branch

  1. Navegue até Ramificações>de Código e localize o branch no qual você deseja configurar a política (normalmente main ou develop). No menu de contexto, selecione a opção Políticas de branch.

    Selecionar políticas do Branch no menu de contexto

  2. Role para baixo para localizar Verificações de status. Selecione o botão +.

    Selecione o botão Adicionar política

  3. Selecione o serviço para o qual você deseja criar uma política na lista. Se o status tiver sido postado anteriormente, você poderá selecioná-lo na lista; se for uma nova política, você poderá digitar o nome da política.

    Selecione a política na lista

    • O requisito de política determina se essa política é opcional ou necessária para concluir solicitações de pull no branch.
    • A identidade autorizada é usada para impor que somente os status da identidade especificada sejam contados no cumprimento da política.
    • As condições de redefinição são usadas para determinar quando um status postado não é mais válido. Se o status postado for específico para o código mais recente (ou seja, um build), marque Redefinir status sempre que houver novas alterações para redefinir o status quando o branch de origem for alterado.
    • Opcionalmente, defina um filtro Path. Saiba mais sobre filtros de caminho em políticas de branch.
    • A aplicabilidade da política determina se essa política se aplica assim que uma solicitação de pull é criada ou se a política se aplica somente após o primeira status ser postado na solicitação de pull.
    • O nome de exibição padrão permite que você especifique um nome de exibição opcional para sua política.

Criar uma nova solicitação pull

  1. Crie uma nova solicitação de pull no branch em que a política está definida. Para saber mais, confira Criar uma solicitação de pull.

  2. Depois de criar a PR, a nova política aparecerá na seção Políticas da exibição de detalhes de PR. Inicialmente, a política aparecerá como não definida até que o serviço externo tenha postado algum status.

    O status da política está visível na seção de Políticas

    Quando o serviço tiver postado status, a política será atualizada de acordo. A conclusão será bloqueada até que a política aprove a PR.

    Atualizações de status da política

    Quando os critérios da política forem atendidos e o serviço postar um status succeeded, a PR será aprovada e a conclusão será desbloqueada.

    Status de política aprovado e conclusão desbloqueada

Resumo

Neste artigo, você aprendeu a configurar uma política de branch para um serviço externo.