Como conduzir revisões de código com solicitações de mesclagem do GitLab

As solicitações de mesclagem do GitLab são sua chance de revisar o código antes que ele entre no branch principal do seu projeto. Um Merge Request (MR) é um wrapper em torno de uma operação git merge que pode ser acessada na IU da Web do GitLab. Depois de revisar seu código, você pode iniciar a mesclagem com um único clique. A adoção de um fluxo de trabalho orientado por MR ajuda a garantir a qualidade do código, criando uma expectativa de que todos os commits sejam completamente revisados.

As solicitações de mesclagem são um dos elementos fundamentais da experiência GitLab. Eles combinam seus sistemas de gerenciamento de projeto, repositório e CI / CD em uma única página para cada mudança em sua base de código. Estamos usando o GitLab CE de código aberto neste artigo. As camadas comerciais têm acesso a recursos adicionais.

Criação de uma solicitação de mesclagem

Você pode criar um novo MR a partir do GitLab navegando até Repositório > Ramos na barra lateral. Certifique-se de ter enviado as alterações em seu branch local para o GitLab. Encontre o branch que deseja mesclar e clique no botão “ Solicitação de mesclagem ” botão à direita de seu nome.

Use o formulário para definir as propriedades de sua solicitação de mesclagem. Comece nomeando seu novo MR. Em seguida, adicione uma descrição. Os padrões para descrições variam por organização e por projeto. Em geral, você desejará anotar todas as alterações importantes que você fez, bem como o raciocínio por trás delas.

Na parte inferior da página, você encontrará controles para definir o responsável, revisor, marco e rótulos do MR ’. Eles podem ser alterados a qualquer momento usando a barra lateral direita na página de detalhes da solicitação de mesclagem. Nós os cobriremos com mais detalhes posteriormente.

Você pode concluir uma revisão inicial sem enviar seu MR. Use a opção “ Commits ” e “ Alterações ” para confirmar se você incluiu o código correto. Quando estiver pronto, clique no botão verde “ Enviar solicitação de mesclagem ” botão para abrir o MR. Você pode visualizar todos os MRs em seu projeto usando a “ Solicitações de mesclagem ” link na barra lateral.

Criando solicitações de mesclagem de seu terminal

A criação de MRs por meio da IU do GitLab incentiva você a marcar com precisão o MR com rótulos, marcos e texto descritivo. No entanto, é um processo trabalhoso que pode consumir muito tempo ao longo do dia. O GitLab oferece suporte a opções de push do Git que permitem que você envie um branch e crie um MR ao mesmo tempo.

 git push -u origin HEAD -o merge_request. create -o merge_request. target = master 

Usar git push com as opções mostradas acima irá enviar seu branch atual para seu remoto Git. O branch remoto será criado novamente, usando o mesmo nome do seu branch local, se ainda não existir. As duas opções -o serão processadas pelo GitLab. Eles resultarão em um novo MR sendo aberto para mesclar seu branch no master.

O GitLab preencherá automaticamente o título e a descrição do MR &’ usando as informações de seu último commit. Além disso, você pode fazer referência a um problema do GitLab em sua mensagem de confirmação – por exemplo. Correções # 123 – para que o GitLab aplique automaticamente seus rótulos e marcos ao MR.

Revisão de solicitações de mesclagem

Nenhum código está completo até que seja revisado. Você pode facilmente solicitar que outros em seu grupo dêem uma olhada em seus commits. Use a barra lateral direita para selecionar um ou mais revisores. Eles serão notificados sobre sua solicitação.

Você também pode atribuir seu MR a outro usuário. Isso pode indicar que eles precisam atualizar suas áreas de responsabilidade para adicionar compatibilidade com suas alterações. Não há regras rígidas e rápidas sobre como você deve usar esses recursos.

Quando você &’ recebeu a tarefa de revisar um MR, mude para a seção “ Commits ” e “ Alterações ” guias na parte superior da tela. O primeiro fornece uma lista de todos os novos commits em seu branch, enquanto o último apresenta os diffs do arquivo para aplicar ao código-base.

Você pode ajustar o layout da tela Alterações usando a engrenagem de configurações no canto superior direito. Você pode escolher entre as diferenças Inline e Lado a Lado, a última exibindo o “ antigo ” e “ novo ” versões de arquivos em uma visão dividida. Você pode ajudar a se concentrar e melhorar o desempenho da tela, ativando o botão “ Mostrar um arquivo por vez ” opção.

Fazendo alterações em seu código

Apesar de todos os seus esforços, às vezes você revisará seu RM e descobrirá um problema que não havia detectado antes. Você não precisa voltar diretamente para o seu editor de código. A tela Mudanças tem disposições disponíveis para ajudá-lo a corrigir os erros assim que os encontrar.

Para correções simples de uma linha, passe o mouse sobre a linha em questão. Clique no ícone de comentário que aparece à esquerda da linha. O editor de comentários aparecerá, apresentando o editor Markdown padrão do GitLab. Você pode usar este recurso para comentar sobre linhas específicas em seu MR – suas mensagens aparecerão na página “ Visão geral ” aba. No entanto, estamos procurando um recurso específico, a página “ Inserir sugestão ” botão na barra de ferramentas.

Clique no botão para inserir a linha selecionada em seu comentário. Use o editor de comentários para editar a linha de acordo com sua aparência. Em seguida, clique em “ Iniciar uma revisão ” ou “ Adicionar comentário agora ”. O primeiro permite que você mantenha vários comentários juntos para enviar em lote assim que você concluir sua revisão.

Depois de salvar seu comentário, você verá uma “ Alteração sugerida ” widget aparece abaixo da linha suspeita. Isso exibirá a nova diferença a ser aplicada. Clique no link “ Aplicar sugestão ” botão para adicionar instantaneamente sua alteração.

O uso de sugestões pode reduzir drasticamente o tempo para corrigir pequenos problemas, já que você não precisa sair do navegador. Para edições mais longas, você pode clicar no ícone de três pontos próximo a qualquer arquivo na tela de Mudanças para abri-lo em todo o GitLab Web IDE.

Solicitações de mesclagem de rascunho (trabalho em andamento)

Às vezes, você vai querer empurrar o código antes que ele esteja pronto para mesclar. Você pode distinguir esses MRs prefixando seus títulos com “ Rascunho ” ou clicando no botão da barra de ferramentas. Rascunhos de MRs não podem ser mesclados até que você revogue manualmente seu status de rascunho clicando em “ Marcar como pronto ” no canto superior direito.

Esta funcionalidade costumava ser chamada de “ Trabalho em andamento, ” usando o “ WIP ” prefixo do título. Essa terminologia foi abandonada em favor de “ Rascunho, ” que será a única variante com suporte no GitLab 14. Ambos os formulários estão disponíveis no GitLab 13.

À medida que você adiciona commits aos seus MRs, eles &’ serão listados na seção Visão geral da página MR. Você pode clicar no link “ Comparar com a versão anterior ” link para ver a diferença dessas mudanças isoladamente.

Clicar no link “ Alterações ” guia sem escolher uma versão exibe a diferença de todo o MR em relação ao ramo de destino. Você pode ver a diferença de quaisquer duas versões usando o menu “ Comparar [mestre] e [versão mais recente] ” menus suspensos na parte superior da tela de Mudanças.

Concluindo sua revisão

Depois de concluir sua revisão, é hora de mesclar seu código. Você precisará revogar o status Rascunho do MR &’ se ele tiver sido definido. Dependendo das configurações do seu projeto, talvez você também precise “ resolver ” quaisquer tópicos de comentários que foram criados.

Para sinalizar que o MR está pronto para ser mesclado, use o botão azul “ Aprovar ” botão. Isso não executa nenhuma ação no GitLab, exceto sinalizar para sua equipe que o MR foi aceito. Você pode então prosseguir e mesclar o MR pressionando o botão verde “ Merge ” botão.

Use o botão “ Excluir branch de origem ” caixa de seleção para controlar se o branch será excluído após a fusão. Isso ajuda a manter sua lista de ramos enxuta, mas pode levar à perda de contexto no futuro. Os “ commits do Squash ” opção permite combinar todos os commits no MR em um. Isso cria um histórico de commits mais organizado, mas tornará mais difícil reverter alterações individuais no futuro. A disponibilidade dessas opções dependerá das configurações definidas no seu projeto e no seu grupo.

As solicitações de mesclagem fornecem uma boa estrutura para escrever e revisar o código. Ao mesmo tempo, eles são extremamente flexíveis e abertos à interpretação. Depende de você até que ponto desenvolver seu fluxo de trabalho de solicitação de mesclagem.

Neste artigo, examinamos apenas os recursos diretamente relevantes para um revisor de código. Você poderá ver muito mais informações em suas solicitações de mesclagem se usar outros recursos do GitLab. A página Visão geral pode exibir o status do pipeline de CI, relatórios de qualidade de teste e código, resultados de varredura de segurança e links de ambiente de preparação, todos os quais tornam a página MR seu primeiro destino ao entender como uma mudança afetará seu projeto.