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 na main ramificação. Como bônus, você também corrigirá o erro de digitação na página inicial do site Space Game .

Atualmente, a equipa permite que qualquer pessoa que faça um pedido Pull intercale o código no ramo main. Como nenhuma revisão é necessária, é possível que o código incorreto ou instável se instale.

O Guilherme decide que quer adicionar uma verificação adicional ao pedido Pull. Ele quer configurar o GitHub para exigir que alguém que não seja o autor da solicitação pull revise o código antes que ele seja mesclado. Vamos ver como fazer isso.

O Guilherme vai à procura da Teresa e vê-a na secretária a trabalhar, com a cabeça a abanar ao som da música nos auriculares.

Andy: Mara, eu tenho falado com você sobre alguma coisa.

A Teresa ergue os olhos.

Mara: Em que posso ajudá-la?

Andy: Vários pequenos erros estão cometendo isso através da construção. Hoje mesmo, um erro de digitação apareceu na página inicial. A Mariana está a gastar demasiado tempo nestas coisas. Temos de corrigi-los antes de chegarem ao ramo main. Precisamos de uma verificação adicional ao código antes de aprovar o pedido Pull.

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

Configurar aprovações

Nesta seção, você configurará uma regra no GitHub que exige que pelo menos um revisor aprove uma solicitação pull antes que ela possa ser mesclada na main ramificação. Em seguida, você verificará se a regra funciona pressionando uma correção para o erro de digitação que Mara fez anteriormente.

Adicionar a regra

  1. No GitHub, vá para o repositório do seu projeto Space Game .
  2. Selecione a guia Configurações na parte superior da página.
  3. No menu à esquerda, selecione Ramos.
  4. Certifique-se de que main está selecionado como sua ramificação padrão.
  5. Selecione Adicionar regra de proteção de ramificação.
  6. Em Padrão de nome da filial, insira principal.
  7. Marque a caixa de seleção Exigir uma solicitação pull antes de mesclar .
  8. Marque a caixa de seleção Exigir aprovações .
  9. Mantenha o valor de Revisões de aprovação obrigatórias em 1.
  10. Selecione Criar.
  11. Selecione Guardar alterações.

Nota

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

Submeter a correção

Nesta seção, você envia uma correção para o erro de digitação na página inicial. Lembre-se que a palavra "oficial" está digitada incorretamente como "oficial".

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

  1. No Visual Studio Code, aceda ao terminal.

  2. Para verificar a filial, execute git checkout:main

    git checkout main

  3. Para extrair as alterações mais recentes para a main ramificação do GitHub, execute git pull:

    git pull origin main

    Você pode ver que dois arquivos são atualizados:

    • README.md: Contém o código Markdown para exibir o selo de compilação.
    • Index.cshtml: Contém o texto atualizado da página inicial, que inclui o erro de digitação.

  4. Para corrigir o erro, crie e faça check-out de uma ramificação:

    git checkout -B bugfix/home-page-typo

  5. No Explorador de Ficheiros, 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. Guarde o ficheiro.

  9. No terminal, encene 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 criaria e executaria o site localmente para verificar a alteração. Nesta unidade, por uma questão de brevidade, vamos pular essa etapa.

  10. Emita o ramo para o GitHub.

    git push origin bugfix/home-page-typo

Testar a regra

  1. No GitHub, localize e selecione a bugfix/home-page-typo ramificação.

    Captura de tela do GitHub mostrando a ramificação recentemente empurrada.

  2. Para iniciar sua solicitação pull, selecione Contribute e, em seguida, Open pull request.

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

    Captura de tela do GitHub confirmando que a ramificação pode ser mesclada.

  4. Selecione Criar pull request.

    Você pode ver que uma revisão humana é necessária antes de mesclar a alteração.

    Captura de tela de uma solicitação pull no GitHub mostrando que uma revisão é necessária para mesclar.

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

  5. Marque a caixa de seleção Mesclar sem aguardar o cumprimento dos requisitos (ignorar proteções de ramificação) e, em seguida, selecione Mesclar solicitação pull.

  6. Selecione Confirmar mesclagem.

    A alteração é intercalada.

  7. Para excluir a bugfix/home-page-typo ramificação, selecione Excluir ramificação.