Protegendo sua branch principal de commits diretos

A ideia com esse post é fazer com que todos os commits sejam enviados para branch principal através de PRs, dado que agora sempre rodamos os testes nele.

Continuando nossas alterações feitas neste repositório...
Já criamos testes para nossa API e fizemos nossos testes rodarem automaticamente com o Github Actions. Agora vamos proteger nossa branch para que não sejam permitidos commits diretamente na nossa branch principal.

Por que isso é tão importante?

No meu ponto de vista, isso é importante pelo motivo de eu considerar a branch principal um local onde deve sempre estar o código de produção. Não devemos inserir códigos incompletos, ou sem testes, etc.
Não que isso possa ser inserido através de um PR, mas com um PR, temos uma revisão do código, para ajudar a impedir esse tipo de situação.
Eu mesmo não faço isso em todos os meus projetos, mas sempre que estou alterando algo grande, eu abro um PR e reviso.

Devemos sempre evitar possíveis bugs em nosso código.

Como fazer isso no Github?

Primeiro passo é garantir que você tenha acesso para criar regras de proteção de branches no Github. Basta irmos em Settings → Branches como na imagem abaixo.

Configurações de Branches dentro do Github

Após isso, temos a opção Branch protection rules onde configuramos nossas regras de proteção de branch como o próprio nome já diz.

Nós vamos adicionar uma nova regra.

Regras de proteção de branch, com botão para adicionar novas regras destacado.

O primeiro passo é escolher para qual branch vamos aplicar a regra. Podemos ter regras específicas para branches específicas, e podemos utilizar regex, por exemplo, hotfix/* aplicaria a regra para todas as branches que começam com hotfix/

Input para inserir o nome ou padrão da branch

Agora com a branch definida, vamos começar a escolher as regras.

Lista de regras disponíveis para aplicarmos em uma branch

  • Require pull request reviews before merging

    Com essa regra, todo código deverá passar por um PR antes de ser feito merge.
    Esperamos que pelo menos uma pessoa revise.

  • Dismiss stale pull request approvals when new commits are pushed

    Essa regra faz com que as aprovações anteriores sejam descartadas quando feito push com novos commits, precisando de novas aprovações.

  • Require linear history

    Essa não é uma regra para bloquear os commits, ela útil para termos um histórico de commits linear, ou seja, ao invés de fazer merge ele irá fazer rebase.

  • Include administrators

    Essa regra é extremamente importante quando se fala da proteção, com ela forçamos os administradores do repositório a seguir as regras mencionadas anteriormente. Caso contrário, eles(administradores) poderiam escapar de todas elas.

Após isso, devemos salvar nossas alterações, e agora não podemos ter novos commits diretos em nossa branch principal.

Enquanto estivermos em nosso computador ainda vamos conseguir fazer os commits na branch, mas ao tentar subir o código teremos um erro devido à proteção.

Comandos do git sendo executados no terminal

Bom, assim acabamos de proteger nossa branch, garantindo um processo de Code Review mais forte dentro do nosso projeto.

No próximo post, vamos adicionar mais uma verificação na proteção da branch. Queremos que nossos testes sejam executados em cada PR e apenas com todos os testes passando, permitir que o PR seja aceito.

Obrigado por terem lido até aqui. Até a próxima.

Comentários