Exercício – Adicionar uma regra para exigir uma revisão

  • 9 minutos

Nesta unidade, você configurará uma regra no GitHub que exige que um revisor aprove as alterações antes que elas possam ser mescladas ao branch main. Como bônus, você também corrigirá o erro de digitação na home page do site do Space Game.

Atualmente, a equipe permite que qualquer pessoa que fizer uma solicitação de pull mescle o código ao branch main. Como nenhuma revisão é necessária, é possível que um código incorreto ou instável seja inserido.

Paulo decide que deseja adicionar uma verificação à solicitação de pull no formato da revisão por outra pessoa. Ele deseja configurar o GitHub para exigir que alguém que não seja o autor da solicitação de pull examine o código antes que ele seja mesclado. Vejamos como é possível fazer isso.

Paulo vai procurar Clara e a encontra trabalhando em sua mesa, balançando a cabeça no ritmo da música que sai de seus fones de ouvido.

Paulo: Clara, queria falar com você sobre uma coisa.

Clara olha para ele.

Clara: Como posso ajudar?

Paulo: Vários pequenos erros estão passando pelo build. Hoje mesmo um erro de digitação apareceu na home page. Marina está gastando muito tempo com essas coisas. Precisamos detectá-los antes que cheguem ao branch main. Precisamos que outra pessoa revise o código antes que a solicitação de pull seja aprovada.

Clara: Posso configurar isso. No GitHub, há uma maneira de garantir que nenhuma solicitação de pull seja mesclada antes que outra pessoa a revise e aprove.

Configurar aprovações

Nesta seção, você configurará uma regra no GitHub que exige pelo menos um revisor para aprovar um pull request antes que ele possa ser mesclado no branch main. Em seguida, você verificará se a regra funciona efetuando push de uma correção para o erro de digitação que Clara cometeu anteriormente.

Adicionar a regra

  1. No GitHub, acesse o repositório do projeto Space Game.
  2. Selecione a guia Configurações na parte superior da página.
  3. No menu à esquerda, selecione Branches.
  4. Verifique se principal está selecionado como o branch padrão.
  5. Selecione Adicionar regra de proteção de branch.
  6. Em Padrão de nome do branch, insira principal.
  7. Selecione a caixa de seleção Exigir pull request antes de mesclar .
  8. Marque a caixa de seleção Exigir aprovações.
  9. Mantenha o valor Revisões necessárias para aprovação como 1.
  10. Selecione Criar.
  11. Selecione Salvar alterações.

Observação

Na parte inferior da lista de opções, há uma opção chamada Incluir Administradores. Essa opção exige que os administradores do repositório sigam a regra. Você não configurou isso porque é um administrador de seu repositório e não há outro revisor. Nesta unidade, para fins de aprendizado, você revisará e aprovará suas solicitações de pull.

Enviar o conserto

Nesta seção, você enviará uma correção do erro de digitação na home page. Lembre-se de que a palavra "oficial" está digitada incorretamente como "ofcial".

Captura de tela do site do Space Game mostrando um erro de digitação.

  1. No Visual Studio Code, acesse o terminal.

  2. Para fazer check-out do branch main, execute git checkout:

    git checkout main

  3. Para efetuar pull das alterações mais recentes para o branch main do GitHub, execute git pull:

    git pull origin main

    Você verá que dois arquivos foram atualizados:

    • README.md: contém o código Markdown para exibir a notificação de build.
    • Index.cshtml: contém o texto da home page atualizado, o que inclui um erro de digitação.

  4. Para corrigir o erro, crie um branch e faça check-out dele:

    git checkout -B bugfix/home-page-typo

  5. No Explorador de Arquivos, abra Index.cshtml.

  6. Localize o erro:

    <p>Welcome to the oficial Space Game site!</p>

  7. Altere a linha para corrigir o erro:

    <p>Welcome to the official Space Game site!</p>

  8. Salve o arquivo.

  9. No terminal, prepare e confirme a alteração:

    git status
git add Tailspin.SpaceGame.Web/Views/Home/Index.cshtml
git commit -m "Fix typing error on the home page"

    Na prática, você normalmente compilaria e executaria o site localmente para verificar a alteração. Nesta unidade, para sermos breves, vamos ignorar essa etapa.

  10. Envie o branch por push ao GitHub.

    git push origin bugfix/home-page-typo

Teste a regra

  1. No GitHub, localize e selecione o branch bugfix/home-page-typo.

    Captura de tela do GitHub mostrando o branch recém-enviado por push.

  2. Para iniciar sua solicitação de pull, selecione Contribuir e Abrir solicitação de pull.

  3. Defina seu repositório bifurcado como o repositório de base.

    Captura de tela do GitHub confirmando que o branch pode ser mesclado.

  4. Selecione Criar solicitação de pull.

    Você verá que é necessária uma revisão feita por uma pessoa antes de mesclar a alteração.

    Captura de tela de uma solicitação de pull no GitHub que mostra que uma revisão é necessária para a mesclagem.

    Na prática, você atribuiria um membro da equipe para examinar sua alteração. Nesta unidade, você pode mesclar sua própria solicitação de pull para fins de aprendizado.

  5. Marque a caixa de seleção Mesclar sem esperar que os requisitos sejam atendidos (ignorar proteções de ramificação) e, em seguida, selecione Mesclar pull request.

  6. Selecione Confirmar mesclagem.

    Sua alteração foi mesclada.

  7. Para excluir o branch bugfix/home-page-typo, selecione Excluir o branch.