Revise e envie uma solicitação pull

Concluído

O pull request (PR) é o seu ticket para colocar o seu conhecimento na plataforma Learn. Você criou uma RP, mas ela ainda não foi enviada para a fila de RP do repositório de destino. Tal como acontece com muitos projetos de código aberto, há uma série de verificações e revisões que ocorrem para validar as alterações antes de publicar.

Anatomia de uma RP

Captura de ecrã de um pedido pull aberto.

Uma RP mostra o usuário do GitHub que criou a RP, o repositório de destino e a ramificação na qual a RP foi criada. Os RPs contêm várias guias na parte superior, incluindo:

  • Guia Conversa: um painel onde você pode visualizar e responder a comentários de outros colaboradores, ver uma lista de notificações durante todo o processo de criação e revisão e usar a automação de comentários para executar ações.
  • Guia Confirmações: um registro das alterações feitas nessa ramificação.
  • Separador Ficheiros alterados: Uma comparação do(s) ficheiro(s) alterado(s) na RP com o seu estado anterior.

Preste muita atenção à guia Conversa, que é onde todas as atualizações ou notificações aparecem e quaisquer discussões entre você, os revisores e outros colaboradores ocorrem. Você também pode adicionar comentários de hashtag aqui para executar ações, como assinar o PR para indicar que ele está pronto para ser validado e mesclado, ou adiar se precisar pausar o processo.

As RPs geralmente têm rótulos anexados para indicar seu status, como draft para especificar rascunhos de RPs que não estão prontos para revisão, ou do-not-merge para RPs que são novos ou não revisados.

Validação

Antes que seu RP possa ser mesclado em sua ramificação de destino, pode ser necessário passar por um ou mais processos de validação de RP. Depois de selecionar Criar solicitação pull, o GitHub executa as validações configuradas para seu repositório. Quando o processo de validação termina, os resultados aparecem no PR.

Os processos de validação variam consoante o âmbito das alterações propostas e as regras do repositório de destino. Depois de enviar seu RP, você pode esperar que uma ou mais das seguintes situações aconteçam:

  • Capacidade de mesclagem: um teste de mesclabilidade do GitHub de linha de base ocorre primeiro para verificar se as alterações propostas em sua ramificação estão em conflito com a ramificação de destino. Se a RP indicar que esse teste falhou, você deverá reconciliar o conteúdo que está causando o conflito de mesclagem antes que o processamento possa continuar.
  • Contrato de Licença de Contribuição (CLA): Se você estiver contribuindo para um repositório público e não for um funcionário da Microsoft, dependendo da magnitude das alterações propostas, poderá ser solicitado que você conclua um breve CLA na primeira vez que enviar um PR para esse repositório. Depois que a etapa do CLA for liberada, seu PR será processado.
  • Rotulagem: as etiquetas são aplicadas automaticamente ao seu PR para indicar o seu estado à medida que passa pelo fluxo de trabalho de validação. Por exemplo, novos RPs podem receber automaticamente o do-not-merge rótulo, indicando que o RP ainda não concluiu as etapas de validação, revisão e aprovação.
  • Validação e compilação: as suas alterações são examinadas por verificações automatizadas para determinar se passam nos testes de validação. Os testes de validação podem gerar avisos ou erros, exigindo que você faça alterações em um ou mais arquivos em seu PR antes que ele possa ser mesclado. Os resultados do teste de validação são adicionados como um comentário em seu RP para sua revisão, e eles também podem ser enviados para você por e-mail.
  • Teste: as páginas do artigo afetadas pelas suas alterações são implementadas automaticamente num ambiente de teste para análise após validação e compilação bem-sucedidas. Os URLs de Pré-visualização são disponibilizados num comentário de PR.
  • Mesclagem automática: o PR pode ser mesclado automaticamente se passar no teste de validação e em determinados critérios. Neste caso, você não precisa fazer mais nada.

Rever e aprovar

Já está quase! Depois que todo o processamento de RP for concluído, é uma prática recomendada revisar os resultados (por exemplo, comentários de RP, URLs de visualização) para determinar se mais alterações são necessárias antes de aprovar a mesclagem. Se um revisor de RP tiver revisado seu RP, ele também poderá fornecer feedback por meio de comentários se houver questões pendentes ou questões que impeçam a mesclagem.

Use a automação de comentários para executar ações importantes no PR. A automação de comentários permite que os usuários atribuam o rótulo apropriado ao seu PR para atualizar seu estado ou categorizá-lo. Se você estiver trabalhando em um repositório onde a automação de comentários foi implementada, use os comentários de hashtag para atribuir ou alterar rótulos, fechar uma RP ou pausar a mesclagem. Por exemplo, quando terminar de fazer alterações, digite o comentário #sign-off para alterar seu rótulo de RP de do-not-merge para ready-for-review.

Use os comentários na tabela a seguir para executar ações-chave em seu PR:

Comentário de hashtag O que faz
#sign-off Atribui automaticamente o ready-to-merge rótulo para que os revisores no repositório saibam que o PR está pronto para revisão/mesclagem.

Se você não for o autor listado e tentar assinar um PR de repo público usando o #sign-off comentário, o PR será atualizado para indicar que apenas o autor pode atribuir o rótulo.
#hold-off Remove o ready-to-merge rótulo caso mude de ideias ou cometa um erro.
#please-close Fecha o PR se você decidir não ter as alterações mescladas.
#please-open Reabre um PR fechado ou um problema.

Você deve inserir o #sign-off comentário para mesclar suas alterações. Mesmo que todas as avaliações e verificações de validação sejam aprovadas, você é responsável por usar esse comentário para informar aos revisores de relações públicas e aos administradores de repositórios que suas alterações estão prontas para mesclagem do seu lado das coisas. Quando os revisores determinam que sua RP está livre de problemas e assinada, suas alterações são mescladas novamente na ramificação pai e a RP é fechada.

Captura de tela da caixa de comentários em um RP com #sign desativado digitado no campo de comentário e o botão Comentário realçado.

Publicar

Lembre-se, sua RP deve ser mesclada por um revisor de RP antes que as alterações possam ser incluídas na próxima execução de publicação agendada. Normalmente, as RP são revistas e fundidas por ordem de apresentação.

Depois que suas contribuições são aprovadas e mescladas, o processo de publicação as retoma. Dependendo da equipe que gerencia o repositório para o qual você está contribuindo, os tempos de publicação podem variar, mas normalmente ocorrem pelo menos uma vez todos os dias da semana. Os artigos poderão demorar até 45 minutos a aparecer online após a publicação.

Assim que as alterações forem publicadas, elas serão ativadas no Microsoft Learn para que outras pessoas comecem a aprender!

Cenário: Publicar alterações no Serviço de Aplicativo do Azure

Usando sua experiência anterior, você encontrou uma oportunidade de adicionar algumas informações úteis a uma página de documentação do Serviço de Aplicativo e criou uma RP para adicionar suas alterações. Agora você está pronto para revisar e assinar seu RP para publicar suas edições.