Entendendo os hooks do Git

Boas-vindas aos ganchos do Git! Os ganchos do Git são scripts poderosos e personalizáveis que o Git executa automaticamente antes ou depois de eventos como criar commits, enviar alterações ou receber commits enviados.

Pense neles como pontos de verificação ou ações automatizadas no seu fluxo de trabalho do Git. Eles ajudam a impor padrões do projeto, automatizar tarefas e integrar outros sistemas.

Todo repositório Git vem com um diretório .git/hooks. Dentro dele, você encontrará scripts de exemplo de ganchos (geralmente terminados em .sample).

Para ativar um gancho, basta remover a extensão .sample e tornar o arquivo executável. O Git então o executará no momento apropriado.

• Localização: .git/hooks/
• Arquivos: scripts de Shell (Bash, Python, Ruby etc.)
• Ativação: renomear e tornar executável

Os ganchos do Git são classificados em dois tipos principais, com base no local onde são executados:

• Ganchos do lado do cliente: são executados na sua máquina local (por exemplo, antes de criar um commit ou fazer uma rebase). Eles servem para automatizar o fluxo de trabalho pessoal e impor políticas locais.
• Ganchos do lado do servidor: são executados no servidor Git remoto (por exemplo, quando você envia código para um repositório compartilhado). Eles impõem políticas do projeto para todas as pessoas.

O gancho pre-commit é um dos ganchos mais comuns do lado do cliente. Ele é executado *antes* de o Git criar oficialmente um commit.

Se o script pre-commit terminar com um status diferente de zero, o Git cancelará o commit. Isso é perfeito para tarefas como:

• Verificar o estilo do código (procurar erros de estilo)
• Executar testes unitários
• Verificar a existência de arquivos grandes ou dados confidenciais

O gancho commit-msg é executado *depois* que você insere a mensagem do commit, mas *antes* de o commit ser finalizado.

Esse gancho é útil para garantir que as mensagens dos commits sigam convenções ou formatos específicos. Por exemplo, ele pode verificar se:

• A mensagem começa com um ID de chamado (por exemplo, [JIRA-123])
• O tamanho da mensagem está dentro dos limites
• Palavras-chave específicas estão presentes ou ausentes

O gancho post-commit é executado *imediatamente depois* de um commit ser criado com sucesso.

Diferentemente de pre-commit ou commit-msg, esse gancho não pode alterar o resultado do commit. Ele é frequentemente usado para fins de notificação ou integração, como:

• Notificar integrantes da equipe
• Atualizar uma ferramenta de gerenciamento de projetos
• Acionar uma compilação de integração contínua (CI), embora isso seja mais comum com ganchos do lado do servidor

Passando aos ganchos do lado do servidor, pre-receive é executado antes de qualquer referência, como ramificações ou etiquetas, ser atualizada no repositório remoto.

Esse gancho é poderoso para impor políticas essenciais do repositório, como:

• Impedir envios diretos para a ramificação main
• Garantir que todos os commits sejam assinados
• Validar a identidade de quem fez o commit

Se esse gancho terminar com um código diferente de zero, todo o envio será rejeitado.

O gancho post-receive é executado depois que um envio atualiza as referências no repositório remoto com sucesso.

Assim como post-commit, esse gancho não pode rejeitar o envio. Ele é normalmente usado para:

• Acionar pipelines de integração e entrega contínuas
• Atualizar sistemas externos de acompanhamento de problemas
• Enviar notificações por e-mail à equipe
• Implantar o código em um ambiente de preparação

Para criar um gancho, basta criar um arquivo com o nome do gancho, por exemplo, pre-commit, no diretório .git/hooks/. Vamos criar um bem básico:

Depois de criar o script do gancho, você precisa torná-lo executável. Caso contrário, o Git não o executará. Use o comando chmod no seu terminal:

chmod +x .git/hooks/pre-commit

Agora, sempre que você tentar fazer um commit, o Git executará esse script!

Os ganchos do Git são executados em momentos específicos do seu fluxo de trabalho. Entender o momento de execução é essencial para usá-los com eficácia.

Você deu o primeiro passo no poderoso mundo dos ganchos do Git!

• Os ganchos do Git são scripts que automatizam ações durante eventos do Git.
• Eles ficam no diretório .git/hooks/ do seu repositório.
• Os ganchos podem ser do lado do cliente (máquina local) ou do lado do servidor (repositório remoto).
• Ganchos importantes, como pre-commit e pre-receive, podem impor políticas bloqueando operações.
• Ganchos como post-commit e post-receive servem para notificações ou integrações após uma ação.

A seguir, vamos explorar exemplos práticos de implementação de ganchos específicos!