Revisar e enviar um pull request
O pull request (PR) é o seu tíquete para obter seu conhecimento na plataforma Learn. Você criou um PR, mas ele ainda não foi enviado para a fila de PR do repositório de destino. Como acontece com muitos projetos de código aberto, há uma série de verificações e revisões para validar as alterações antes da publicação.
Anatomia de um PR
Um PR mostra o usuário do GitHub que criou o PR, o repositório de destino e a ramificação no qual o PR foi criado. Os PRs contêm várias guias na parte superior, incluindo:
- Guia Conversa: Um painel onde você pode exibir e responder aos comentários de outros colaboradores, ver uma lista de notificações durante 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.
- Guia Arquivos alterados: Uma comparação dos arquivos alterados no PR com o estado anterior.
Dê atenção especial à guia Conversa, onde qualquer atualização ou notificação aparece e onde ocorrem discussões entre você, os revisores e outros colaboradores. Você também pode adicionar comentários de hashtag aqui para realizar ações, como assinar o PR para indicar que está pronto para ser validado e mesclado ou adiar se precisar pausar o processo.
Os PRs geralmente têm rótulos anexados para indicar seu status, como draft para especificar rascunhos de PRs que não estão prontos para revisão ou do-not-merge para PRs que são novos ou que não foram revisados.
Validação
Antes que seu PR possa ser mesclado em sua ramificação de destino, pode ser necessário passar por um ou mais processos de validação de PR. Depois de selecionar Criar pull request, o GitHub executará as validações configuradas para seu repositório. Quando o processo de validação é concluído, os resultados aparecem no PR.
Os processos de validação variam dependendo do escopo das alterações propostas e das regras do repositório de destino. Após enviar seu PR, você pode esperar que um ou mais dos seguintes procedimentos ocorram:
- Mergeability: Um teste de mesclagem 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 o PR indicar que o teste falhou, você deverá reconciliar o conteúdo que está causando o conflito de mesclagem antes que o processamento possa continuar.
- Contrato de Licenciamento de Contribuição (CLA): Se você estiver contribuindo para um repositório público e não for funcionário da Microsoft, dependendo da magnitude das alterações propostas, poderá ser solicitado que você preencha um breve CLA na primeira vez que enviar um PR para esse repositório. Após a conclusão da etapa do CLA, seu PR será processado.
- Rotulagem: Os rótulos são aplicados automaticamente de PR para indicar o estado de seu PR à medida que ele passa pelo fluxo de trabalho de validação. Por exemplo, novos PRs podem receber automaticamente o rótulo “não mesclar”, indicando que o PR ainda não concluiu as etapas de validação, revisão e aprovação.
- Validação e build: verificações automatizadas verificam se suas alterações passam pelos 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 no seu PR antes que ele possa ser mesclado. Os resultados do teste de validação são adicionados como um comentário em seu PR para sua revisão e também podem ser enviados a você por email.
- Preparo: as páginas do artigo afetadas pelas suas mudanças podem ser implantadas automaticamente em um ambiente de preparo para análise depois que a validação e o build forem bem-sucedidos. As URLs de visualização aparecem em um comentário de PR.
- Mesclagem automática: O PR poderá ser mesclado automaticamente se passar no teste de validação e em determinados critérios. Nesse caso, você não precisa fazer mais nada.
Revisar e sair
Você está quase lá! Depois que todo o processamento de PR for concluído, é uma prática recomendada revisar os resultados (por exemplo, comentários de PR, URLs de visualização) para determinar se mais alterações são necessárias antes de assinar a mesclagem. Se um revisor de PR revisou seu PR, ele também poderá fornecer feedback por meio de comentários se houver problemas ou dúvidas pendentes que impeçam a mesclagem.
Use a automação de comentários para realizar ações importantes no PR. A automação de comentários permite que os usuários atribuam o rótulo apropriado de 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 um PR ou pausar a mesclagem. Por exemplo, quando terminar de fazer alterações, digite o comentário “#sign-off” para alterar seu rótulo de PR de do-not-merge para ready-for-review.
Use os comentários na tabela a seguir para executar as principais ações em seu PR:
| Comentário da hashtag | O que faz |
|---|---|
#sign-off |
Atribui automaticamente o rótulo pronto para mesclar para permitir 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 repositório público usando o comentário #sign-off, o PR será atualizado para indicar que somente o autor pode atribuir o rótulo. |
#hold-off |
Remove o rótulo pronto para mesclar caso você mude de ideia 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 comentário #sign-off para mesclar suas alterações. Mesmo que todas as revisões e verificações de validação sejam aprovadas, você é responsável por usar esse comentário para informar aos revisores de PR e administradores do repositório que suas alterações estão prontas para serem mescladas do seu lado. Quando os revisores determinam que seu PR está livre de problemas e aprovado, suas alterações são mescladas novamente na ramificação pai e o PR é fechado.
Publicação
Lembre-se de que seu PR deve ser mesclado por um revisor de PR antes que as alterações possam ser incluídas na próxima publicação agendada. Normalmente, os PRs são revisados e mesclados em ordem de envio.
Depois que suas contribuições forem aprovadas e mescladas, elas serão recolhidas pelo processo de publicação. Dependendo da equipe que gerencia o repositório para o qual você está contribuindo, os horários de publicação podem variar, mas normalmente ocorrem pelo menos uma vez por dia da semana. Pode levar até 45 minutos para que os artigos apareçam online após a publicação.
Depois que suas alterações forem publicadas, elas serão publicadas no Microsoft Learn para que outras pessoas possam começar a aprender!
Cenário: Publicar alterações no Serviço de Aplicativo do Azure
Usando sua experiência anterior, você identificou uma oportunidade de adicionar algumas informações úteis a uma página de documentação do Serviço de Aplicativo e criou um PR para adicionar suas alterações. Agora, você está pronto para revisar e assinar seu PR para publicar suas edições.