Criar solicitações de pull

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

Visual Studio 2019 | Visual Studio 2022

Crie PRs (pull requests) para alterar, revisar e mesclar código em um Repositório do Git. Você pode criar PRs de branches no repositório upstream ou de branches na bifurcação do repositório. Sua equipe pode revisar as PRs e fornecer comentários sobre as alterações. Os revisores podem executar as alterações propostas, deixar comentários e votar para aprovar ou rejeitar as PRs. Dependendo de políticas de branch e outros requisitos, sua PR pode precisar atender a vários critérios antes que você possa concluir a PR e mesclar as alterações no branch de destino.

Para obter diretrizes de PR e considerações de gerenciamento, consulte Sobre solicitações de pull.

Pré-requisitos

  • Acesso:
    • Acesso Básico: para exibir ou examinar PRs, você deve ser membro de um projeto do Azure DevOps com acesso Básico ou superior.
    • Acesso de Stakeholder: para projetos públicos, os usuários que receberam acesso de Stakeholder têm acesso total ao Azure Repos.
  • Permissões:
    • Habilitado para repositório: os repositórios devem estar habilitados no seu projeto. Se o hub Repos e as páginas associadas não forem exibidos, consulte Ativar ou desativar um serviço do Azure DevOps para reabilitar os repositórios.
    • Associação ao projeto:
    • Grupo de segurança leitores: para contribuir com um PR, você deve ser membro do grupo de segurança Leitores ou ter as permissões correspondentes.
    • Grupo de segurança Colaboradores: para criar e concluir uma PR, você deve ser membro do grupo de segurança Colaboradores ou ter as permissões correspondentes.
  • Ferramentas:
  • Acesso:
    • Acesso Básico: para exibir ou examinar PRs, você deve ser membro de um projeto do Azure DevOps com acesso Básico ou superior. Se você não for um membro do projeto, será adicionado.
  • Permissões:
    • Habilitado para repositório: os repositórios devem estar habilitados no seu projeto. Se o hub Repos e as páginas associadas não forem exibidos, consulte Ativar ou desativar um serviço do Azure DevOps para reabilitar os repositórios.
    • Grupo de segurança leitores: para contribuir com um PR, você deve ser membro do grupo de segurança Leitores ou ter as permissões correspondentes.
    • Grupo de segurança Colaboradores: para criar e concluir uma PR, você deve ser membro do grupo de segurança Colaboradores ou ter as permissões correspondentes.

Para obter mais informações sobre permissões e acesso, consulte Permissões padrão de repositório Git e de branch e Sobre níveis de acesso.

Criar uma solicitação de pull

Você pode criar uma nova PR no site do projeto do Azure DevOps, no Visual Studio ou na CLI do Azure DevOps.

No site do projeto do Azure DevOps, você pode criar uma nova PR de:

Criar uma PR na página Solicitações de pull

Você pode criar PRs para qualquer branch na página Solicitações de pull do projeto na Web.

  1. Na páginaSolicitações> de Pull de Repos, selecione Nova solicitação de pull no canto superior direito.

    Captura de tela do botão Nova solicitação de pull.

  2. Selecione o branch com as alterações e o branch no qual você deseja mesclar as alterações, como a branch principal.

    Captura de tela de branches de origem e de destino para uma PR no Azure Repos.

  3. Insira seus detalhes de PR e crie a PR.

Criar uma PR com base em um branch enviado por push

Depois de enviar por push ou atualizar um branch de recurso, o Azure Repos exibe um prompt para criar uma PR.

  • Na página Solicitações de Pull:

    Captura de tela que mostra o prompt para criar uma PR na guia Solicitações de Pull no Azure Repos.

  • Na página Arquivos :

    Captura de tela que mostra o prompt para criar uma PR na guia Arquivos no Azure Repos.

Selecione Criar uma solicitação de pull para ir para uma página em que você pode inserir seus detalhes de PR e criar a PR.

Criar uma PR com base em um item de trabalho vinculado

Você pode criar uma PR diretamente de um item de trabalho Azure Boards vinculado ao branch.

  1. Em Azure Boards, em Listas de pendências ou consultas no modo de exibição Trabalho, abra um item de trabalho vinculado ao branch.

  2. Na área Desenvolvimento do item de trabalho, selecione Criar uma solicitação de pull.

    Captura de tela da criação de uma PR da área de Desenvolvimento de um item de trabalho com um branch vinculado.

O link leva você para uma página em que você pode inserir seus detalhes de PR e criar a PR.

Adicionar atualizações com cherry-pick

Copie commits de um branch para outro usando a opção cherry-pick. Ao contrário de uma mesclagem ou troca de base, cherry-pick traz apenas as alterações dos commits selecionados, em vez de todas as alterações em um branch.

Para escolher as alterações de uma PR concluída, selecione Cherry-pick na página Visão geral da PR. Para copiar as alterações de uma PR ativa, selecione Cherry-pick no menu Mais opções da PR. Essa ação cria um novo branch com as alterações copiadas. Em seguida, você pode criar uma nova PR a partir do novo branch. Para obter instruções detalhadas, consulte Copiar alterações com cherry-pick.

Alternar branches de origem e destino da sua solicitação de pull

Antes de salvar uma PR pela primeira vez, você pode alternar os branches de origem e de destino da PR selecionando o ícone Alternar branches de origem e de destino ao lado dos nomes de branch. Quando a PR estiver ativa, esse ícone desaparecerá, mas você ainda poderá alterar o branch de destino da PR.

Captura de tela do ícone de branches de origem e de destino do switch.

Usar modelos de solicitação de pull

Um modelo de solicitação de pull é um arquivo que contém o texto Markdown que preenche a descrição de PR quando você cria uma PR. Boas descrições de PR dizem aos revisores de PR o que esperar e podem ajudar a acompanhar tarefas como adicionar testes de unidade e atualizar a documentação. Sua equipe pode criar um modelo de PR padrão que adiciona texto a todas as novas descrições de PR no repositório. Além disso, você pode selecionar entre modelos específicos de branch ou outros modelos definidos por sua equipe. Para obter mais informações sobre como criar e usar modelos de PR, consulte Aprimorar descrições de solicitação de pull usando modelos.

Se o repositório tiver um modelo padrão, todas as PRs no repositório terão o texto de descrição do modelo padrão na criação. Para adicionar outros modelos, selecione Adicionar um modelo e escolha um modelo na lista suspensa. Você pode editar o texto do modelo em sua descrição, removê-lo ou adicionar outro texto.

Captura de tela mostrando Adicionar um modelo ao criar uma PR.

Criar PRs de rascunho

Se sua PR não estiver pronta para revisão, você poderá criar uma PR de rascunho para indicar o trabalho em andamento. Quando a PR estiver pronta para revisão, você poderá publicá-la e iniciar ou retomar o processo de revisão completo.

As PRs de rascunho têm as seguintes diferenças em relação às PRs publicadas:

  • As políticas de validação de build não são executadas automaticamente. Você pode enfileirar validações de build manualmente selecionando o menu mais opções na PR.

  • A votação está desabilitada no modo de rascunho.

  • Os revisores necessários não são adicionados automaticamente. As notificações são enviadas somente aos revisores que você adiciona explicitamente à PR de rascunho.

  • PRs de rascunho são exibidas na lista de PR com uma notificação rascunho .

    Captura de tela mostrando uma PR de rascunho na lista de PR.

Observação

A criação de PRs de rascunho requer Azure DevOps Server 2019.1 ou versão posterior.

Para criar uma PR de rascunho, selecione a seta ao lado de Criar e selecione Criar como rascunho ao criar a PR. Você não precisa usar prefixos de título, como WIP ou NÃO MESCLAR.

Captura de tela mostrando Criar como PR de rascunho.

Quando estiver pronto para que a PR seja revisada e concluída, selecione Publicar no canto superior direito na PR. A publicação de uma PR atribui os revisores necessários, avalia as políticas e inicia a votação.

Captura de tela mostrando Publicar para uma PR.

Para alterar uma PR publicada existente para um rascunho, escolha Marcar como rascunho. Marcar uma PR como rascunho remove todos os votos existentes.

Captura de tela mostrando Marcar como rascunho.

Adicionar ou editar título e descrição da solicitação de pull

Na página Nova solicitação de pull , insira um Título e uma Descrição detalhada de suas alterações, para que outras pessoas possam ver quais problemas as alterações resolvem. Em uma nova PR como em PRs existentes, você pode ver os Arquivos e Commits em sua PR em guias separadas. Você pode adicionar revisores, vincular itens de trabalho e adicionar marcas à PR.

Quando estiver pronto para revisar as alterações, selecione Criar para criar a PR.

Captura de tela que mostra a criação de uma nova PR.

Adicionando detalhes a uma nova PR.

Não se preocupe se você não tiver todos os itens de trabalho, revisores ou detalhes prontos ao criar sua PR. Você pode adicionar ou atualizar esses itens depois de criar a PR.

Editar título e descrição da PR

Mantenha o título e a descrição da PR atualizados para que os revisores possam reconhecer as alterações na PR.

Você pode atualizar o título de uma PR existente selecionando o título atual e atualizando o texto. Selecione o ícone Salvar para salvar as alterações ou selecione o ícone Desfazer para descartar as alterações.

Edite a descrição da PR selecionando o ícone Editar na seção Descrição .

Captura de tela que mostra a edição do título da PR e a seleção do botão Editar de descrição.

Adicionar revisores a uma solicitação de pull

Você pode adicionar revisores na seção Revisores de uma PR nova ou existente. Você também pode tornar necessários revisores opcionais existentes ou alterar os revisores necessários para opcionais ou removê-los, a menos que sejam exigidos pela política.

As políticas de branch podem exigir um número mínimo de revisores ou incluir automaticamente determinados revisores opcionais ou necessários nas PRs. Não é possível remover revisores exigidos pela política de branch. Você pode alterar os revisores opcionais da política de branch para serem necessários ou removê-los.

Para ver a política de branch que adicionou automaticamente um revisor, na seção Revisores da página Visão geral de PR, clique com o botão direito do mouse em Mais opções ao lado do revisor.

Captura de tela que mostra a política de Exibição em um revisor que é automaticamente incluído pela política de branch.

Se o usuário ou grupo que você deseja para revisar sua PR não for membro do projeto, você precisará adicioná-lo ao projeto antes de adicioná-lo como revisores.

Para adicionar revisores a uma nova PR:

  1. Na página Nova solicitação de pull , em Revisores, selecione Pesquisar usuários e grupos para adicionar como revisores.
  2. Conforme você insere um nome ou endereço de e-mail, uma lista suspensa mostra uma lista de usuários e grupos correspondentes. Selecione nomes na lista para adicionar como revisores opcionais.
  3. Para adicionar os revisores necessários, selecione Adicionar revisores necessários e, em seguida, selecione Pesquisar para adicionar os revisores necessários para pesquisar e selecionar os nomes.

Captura de tela da adição de um revisor a uma nova PR.

Para adicionar revisores a uma PR existente:

  1. Na seção Revisores da página Visão geral , selecione Adicionar e, em seguida, selecione Revisor obrigatório ou Revisor opcional.

    Visão geral da solicitação pull

  2. Conforme você insere um nome ou endereço de e-mail, uma lista de usuários ou grupos correspondentes aparece. Selecione os nomes a serem adicionados como revisores.

    Adicionar revisor de PR.

Para alterar um revisor entre obrigatório e opcional ou remover um revisor, selecione Mais opções à direita do nome do revisor. Para ver a associação de um grupo ou equipe designada como revisor, selecione o ícone do grupo.

Para vincular itens de trabalho a uma nova PR:

  1. Na página Nova solicitação de pull, em Itens de trabalho a serem vinculados, selecione Pesquisar itens de trabalho por ID ou título.
  2. Comece a inserir uma ID ou título de item de trabalho e selecione o item de trabalho a ser vinculado na lista suspensa exibida. A pesquisa por título retorna itens de trabalho filtrados por estado; todos os itens de trabalho com estados com categorias de estado Concluídas e Removidas são excluídos. Esses itens de trabalho também são filtrados por data e usuário, com apenas itens criados ou atualizados nos últimos 30 dias mostrados, e eles devem ser criados, atribuídos ou autorizados como o usuário atual.

Para vincular itens de trabalho a uma PR existente:

  1. Na guia Visão geral da PR, na área Itens de trabalho, selecione +.

    Captura de tela que mostra a seleção da guia Visão Geral e a seção de itens de trabalho.

  2. Insira a ID do item de trabalho ou pesquise o título do item de trabalho. Selecione o item de trabalho na lista exibida.

Remova um link de item de trabalho selecionando o ícone x ao lado do item de trabalho. Remover um link remove apenas o link entre o item de trabalho e a PR. Os links criados no branch ou nos commits permanecem no item de trabalho.

Para vincular itens de trabalho a uma nova PR:

  1. Selecione a guia Visão geral na PR.

    Captura de tela que mostra a seleção da guia Visão Geral e o botão itens de trabalho.

  2. Selecione o botão adicionar na área Itens de Trabalho . Adicionar ícone nas PRs

  3. Insira a ID do item de trabalho ou pesquise itens de trabalho com títulos que correspondam ao texto. Selecione o item de trabalho na lista exibida. A pesquisa por título retorna itens de trabalho filtrados por estado; todos os itens de trabalho com estados com categorias de estado Concluídas e Removidas são excluídos. Esses itens de trabalho também são filtrados por data e usuário, com apenas itens criados ou atualizados nos últimos 30 dias mostrados, e eles devem ser criados, atribuídos ou autorizados como o usuário atual.

Remova os links de item de trabalho selecionando o botão remover que aparece quando você passa o mouse sobre o item de trabalho. botão remover Remover um link remove apenas o link entre um item de trabalho para uma PR. Os links criados no branch ou nos commits permanecem no item de trabalho.

Adicionar marcas a uma solicitação de pull

Use marcas para mostrar detalhes importantes e ajudar a organizar PRs. As marcas podem comunicar informações extras aos revisores, como que a PR ainda é um trabalho em andamento ou é um hotfix para uma versão futura.

Captura de tela mostrando PRs com marcas.

Para adicionar uma marca ao criar uma PR, digite um nome de marca na seção Marcas . Depois de criar a PR, você pode gerenciar marcas na seção Marcas .

Captura de tela que mostra a seção Marcas da PR em destaque.

Adicionar anexos a solicitações de pull

Você pode anexar arquivos, incluindo imagens, à sua PR durante ou após a criação. Selecione o ícone de clipe de papel abaixo do campo Descrição ou arraste e solte arquivos diretamente no campo Descrição da PR.

Captura de tela que mostra a anexação de arquivos à descrição da PR durante a criação.

Alterar o branch de destino de uma solicitação de pull ativa

Para a maioria das equipes, quase todas as PRs têm como alvo um branch padrão, como main ou develop. Se às vezes você precisar direcionar um branch diferente, é fácil esquecer de alterar o branch de destino ao criar a PR. Se isso acontecer, você poderá alterar o branch de destino de uma PR ativa:

  1. Selecione Mais ações no canto superior direito na página Visão geral da PR e, em seguida, selecione Alterar branch de destino no menu suspenso.
  2. No painel Alterar branch de destino, selecione Escolher um branch de destino, selecione o novo branch e, em seguida, selecione Alterar.

Notificações de e-mail de solicitação de pull para os stakeholders

Você pode compartilhar uma solicitação de pull por e-mail para notificar os revisores e se comunicar com os membros da equipe. Para compartilhar uma PR:

  1. Selecione Mais opções na página Visão geral da PR e, em seguida, selecione Compartilhar solicitação de pull.

    Captura de tela que mostra a seleção da solicitação de pull de compartilhamento na página Visão Geral da PR.

  2. Na tela Compartilhar solicitação de pull, adicione destinatários digitando seus nomes no campo Para: e selecionando entre os nomes de usuário que aparecem. Você também pode remover destinatários.

  3. Adicione uma mensagem opcional no campo Observação (Opcional) e selecione Enviar. Os destinatários recebem um e-mail solicitando sua atenção e vinculando à PR.

Observação

Se você usar o recurso de email interno, só poderá enviar o e-mail para os endereços individuais dos membros do projeto. Não há suporte para a adição de um grupo de equipe ou grupo de segurança à linha Para: . Se você adicionar uma conta de e-mail que o sistema não reconhece, receberá uma mensagem informando que um ou mais destinatários do seu e-mail não têm permissões para ler a solicitação de pull enviada por e-mail.

Para que o recurso de e-mail funcione, o administrador do Azure DevOps Server deve configurar um servidor SMTP.

Próximas etapas