Dominando los hooks de Git: automatización de flujos de trabajo con pre-commit y post-receive
Introducción a los hooks de Git
Los hooks de Git son scripts que se ejecutan automáticamente en respuesta a ciertos eventos del ciclo de vida de Git. Permiten a los desarrolladores y equipos de DevOps automatizar tareas repetitivas, garantizar la calidad del código y optimizar flujos de trabajo. En este artículo exploraremos dos hooks fundamentales: pre-commit y post-receive, con ejemplos prácticos y comandos reales.
¿Qué son los hooks?
Los hooks residen en el directorio .git/hooks de cualquier repositorio Git. Allí encontrarás archivos de ejemplo con extensión .sample. Para activar un hook, simplemente crea un archivo ejecutable con el nombre del hook (sin extensión) y escribe el script deseado (Bash, Python, Ruby, etc.).
Los hooks se dividen en dos categorías:
- Lado del cliente: se ejecutan en la máquina del desarrollador (pre-commit, prepare-commit-msg, commit-msg, post-commit, pre-push, etc.).
- Lado del servidor: se ejecutan en el repositorio remoto (pre-receive, update, post-receive, etc.).
Hook pre-commit: calidad antes del commit
El hook pre-commit se ejecuta justo después de escribir el mensaje de commit pero antes de que el commit se registre. Es ideal para validar el código que se va a confirmar, por ejemplo:
- Ejecutar linters (ESLint, Pylint, etc.).
- Ejecutar pruebas unitarias.
- Verificar que no se incluyan archivos grandes o secretos.
- Formatear el código automáticamente.
Ejemplo: pre-commit para validar Python con flake8
Crea el archivo .git/hooks/pre-commit con el siguiente contenido:
#!/bin/bash echo "Ejecutando flake8 sobre archivos modificados..."Obtener archivos staged (que se van a commitear)
STAGED_FILES=$(git diff —cached —name-only —diff-filter=ACM | grep -E ‘.py$’)
if [ -z “$STAGED_FILES” ]; then echo “No hay archivos Python para validar.” exit 0 fi
Ejecutar flake8
flake8 $STAGED_FILES
if [ $? -ne 0 ]; then echo “Error: flake8 encontró problemas. Corrígelos antes de commitear.” exit 1 fi
echo “Validación exitosa.” exit 0
Luego, hazlo ejecutable:
chmod +x .git/hooks/pre-commitCuando intentes hacer un commit, si flake8 falla, el commit se rechazará.
Herramienta pre-commit framework
Para gestionar hooks de forma más sencilla y compartirlos en equipo, existe pre-commit (pre-commit.com). Se instala con pip y usa un archivo de configuración .pre-commit-config.yaml en la raíz del proyecto. Ejemplo:
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
repo: https://github.com/psf/black rev: 22.10.0 hooks:id: black
Luego instala los hooks con:
pre-commit installEsto crea el script pre-commit automáticamente.
Hook post-receive: despliegue y notificaciones
El hook post-receive se ejecuta en el servidor remoto después de que el push ha sido completado y aceptado. Es perfecto para:
- Desplegar automáticamente en un servidor de producción o staging.
- Enviar notificaciones a Slack, email, etc.
- Actualizar un repositorio espejo o un servicio de integración continua.
- Generar documentación.
Ejemplo: despliegue automático en un servidor web
Supongamos que tienes un repositorio remoto en tu servidor en /var/repo/miweb.git y tu sitio web está en /var/www/miweb. Crea el hook post-receive:
#!/bin/bash TARGET=“/var/www/miweb” GIT_DIR=“/var/repo/miweb.git” BRANCH=“main”
while read oldrev newrev refname do if [ “$refname” = “refs/heads/$BRANCH” ]; then echo “Desplegando rama $BRANCH…” git —work-tree=$TARGET —git-dir=$GIT_DIR checkout -f $BRANCH # Opcional: ejecutar comandos post-despliegue cd $TARGET npm install npm run build systemctl restart nginx fi done
No olvides dar permisos de ejecución:
chmod +x /var/repo/miweb.git/hooks/post-receiveAhora, cada vez que alguien haga push a main, el servidor automáticamente actualizará el sitio.
Consejos y buenas prácticas
- Mantén los hooks rápidos: los hooks se ejecutan de forma síncrona. Si tardan mucho, los desarrolladores se quejarán. Para tareas pesadas, usa hooks del lado del servidor o ejecución asíncrona en post-receive.
- Comparte hooks con el equipo: los hooks locales no se propagan con
git push. Usa herramientas comopre-commito almacena los hooks en un directorio versionado (ej.githooks/) y configuracore.hooksPath:
git config core.hooksPath githooks- Usa scripts en lenguaje conocido: Bash es universal, pero Python, Ruby o Node.js pueden ser más legibles.
- Prueba los hooks: simula eventos con
git commit —no-verify(para saltar pre-commit) o haz push a una rama de prueba.
Posibles problemas y soluciones
- El hook pre-commit no se ejecuta: verifica que el archivo sea ejecutable y que esté en
.git/hooks/con el nombre exacto. - Error de permisos en post-receive: asegúrate de que el usuario que ejecuta git (normalmente el mismo del servidor) tenga permisos de escritura en el directorio destino.
- Salida del hook bloquea el commit: el hook debe salir con código 0 para permitir el commit, distinto de 0 para rechazarlo.
Conclusión
Los hooks de Git son una herramienta poderosa para automatizar flujos de trabajo en DevOps. pre-commit ayuda a mantener la calidad del código antes de que entre al repositorio, mientras que post-receive facilita despliegues continuos y notificaciones. Al dominar estos hooks, puedes reducir errores humanos, ahorrar tiempo y estandarizar procesos. ¡Empieza a implementarlos hoy y lleva tu automatización al siguiente nivel!