Aller au contenu
Outils medium

pre-commit : bloquer les erreurs avant qu'elles n'atteignent le dépôt

12 min de lecture

pre-commit intercepte vos commits et vérifie automatiquement le code avant qu’il n’atteigne le dépôt. Espaces en fin de ligne, fichiers YAML mal formés, secrets exposés : tout est détecté et souvent corrigé automatiquement. Ce guide couvre l’installation, la configuration et les hooks les plus utiles pour un workflow DevOps.

Sans validation automatique, les problèmes de qualité s’accumulent :

  • Espaces en fin de ligne qui polluent les diffs
  • Fichiers YAML ou JSON mal formés qui cassent les pipelines
  • Secrets (clés API, mots de passe) commités par erreur
  • Code non formaté qui crée des conflits de merge

La détection manuelle est impossible à maintenir. Les revues de code perdent du temps sur des détails triviaux au lieu de se concentrer sur la logique.

pre-commit automatise ces vérifications :

Sans pre-commitAvec pre-commit
Secrets détectés en productionBloqués au commit
YAML invalide → pipeline casséValidé avant push
Formatage incohérent entre devsUniformisé automatiquement
Revue de code sur des détailsFocus sur la logique métier

pre-commit utilise les hooks Git — des scripts exécutés automatiquement par Git à certains moments (pré-commit, pré-push, etc.).

Workflow pre-commit : git add déclenche git commit qui exécute les hooks pre-commit (linter, formatteur, scanner de secrets). Tous doivent passer pour que le commit soit accepté.

Chaque hook est un outil indépendant (linter, formatteur, scanner) configuré dans un fichier .pre-commit-config.yaml.

Version actuelle : 4.5.1 (février 2026)

pre-commit est écrit en Python. L’installation recommandée utilise pipx pour isoler les dépendances.

  1. Installer pipx (si pas déjà fait)

    Fenêtre de terminal
    # Ubuntu/Debian
    sudo apt install pipx
    pipx ensurepath
    # Ou avec pip
    pip install --user pipx
    pipx ensurepath
  2. Installer pre-commit

    Fenêtre de terminal
    pipx install pre-commit

    Sortie attendue :

    done! ✨ 🌟 ✨
    installed package pre-commit 4.5.1, installed using Python 3.12.3
    These apps are now globally available
    - pre-commit
  3. Vérifier l’installation

    Fenêtre de terminal
    pre-commit --version
    # pre-commit 4.5.1

À la racine de votre projet Git, créez .pre-commit-config.yaml :

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-json
- id: check-added-large-files
args: ['--maxkb=500']
- id: check-merge-conflict
- id: detect-private-key

Chaque entrée définit :

  • repo : URL du dépôt contenant les hooks
  • rev : version (tag Git) à utiliser
  • hooks : liste des hooks à activer, avec options facultatives
Fenêtre de terminal
pre-commit install

Sortie attendue :

pre-commit installed at .git/hooks/pre-commit

À partir de maintenant, chaque git commit déclenche les vérifications.

Pour exécuter les hooks sans commiter :

Fenêtre de terminal
# Sur les fichiers modifiés (staging area)
pre-commit run
# Sur tous les fichiers du dépôt
pre-commit run --all-files
# Un hook spécifique
pre-commit run trailing-whitespace --all-files
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-yaml
args: ['--unsafe'] # Permet les tags YAML personnalisés (Ansible, K8s)
- id: check-json
- id: check-toml
- id: check-xml
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: detect-private-key
- repo: https://github.com/gitleaks/gitleaks
rev: v8.18.2
hooks:
- id: gitleaks

Exemple de détection :

Fenêtre de terminal
# Créer un fichier avec une clé privée
echo "-----BEGIN RSA PRIVATE KEY-----" > secret.pem
git add secret.pem
git commit -m "Add config"

Sortie :

detect private key...................................................Failed
- hook id: detect-private-key
- exit code: 1
Private key found: secret.pem

Le commit est bloqué — le secret ne rejoint jamais le dépôt.

repos:
- repo: https://github.com/psf/black
rev: 24.4.2
hooks:
- id: black
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.4.4
hooks:
- id: ruff
args: ['--fix']

Black formate le code automatiquement. Ruff détecte et corrige les erreurs de style (remplace flake8, isort, et plus).

repos:
- repo: https://github.com/adrienverge/yamllint
rev: v1.35.1
hooks:
- id: yamllint
args: ['-c', '.yamllint.yaml']

Créez .yamllint.yaml pour personnaliser les règles :

extends: default
rules:
line-length:
max: 120
truthy:
check-keys: false
repos:
- repo: https://github.com/antonbabenko/pre-commit-terraform
rev: v1.88.4
hooks:
- id: terraform_fmt
- id: terraform_validate
- id: terraform_tflint
- repo: https://github.com/ansible/ansible-lint
rev: v24.2.1
hooks:
- id: ansible-lint
repos:
- repo: https://github.com/hadolint/hadolint
rev: v2.12.0
hooks:
- id: hadolint

Voici une configuration DevOps complète :

.pre-commit-config.yaml
repos:
# Vérifications de base
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
args: ['--unsafe']
- id: check-json
- id: check-added-large-files
args: ['--maxkb=500']
- id: check-merge-conflict
- id: detect-private-key
- id: check-case-conflict
- id: mixed-line-ending
args: ['--fix=lf']
# Sécurité
- repo: https://github.com/gitleaks/gitleaks
rev: v8.18.2
hooks:
- id: gitleaks
# YAML
- repo: https://github.com/adrienverge/yamllint
rev: v1.35.1
hooks:
- id: yamllint
# Markdown
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.39.0
hooks:
- id: markdownlint
args: ['--fix']
# Shell
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.10.0.1
hooks:
- id: shellcheck

Les hooks utilisent des versions fixes (rev:). Pour les mettre à jour :

Fenêtre de terminal
pre-commit autoupdate

Sortie exemple :

[https://github.com/pre-commit/pre-commit-hooks] updating v5.0.0 -> v6.0.0
[https://github.com/gitleaks/gitleaks] updating v8.18.2 -> v8.30.0

Commitez ensuite le fichier .pre-commit-config.yaml mis à jour.

Exécutez pre-commit dans votre pipeline pour détecter les commits qui auraient contourné les hooks locaux.

.github/workflows/pre-commit.yml
name: pre-commit
on:
push:
pull_request:
jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- uses: pre-commit/action@v3.0.1
.gitlab-ci.yml
pre-commit:
image: python:3.12
stage: lint
before_script:
- pip install pre-commit
script:
- pre-commit run --all-files --show-diff-on-failure
OptionDescription
--all-filesVérifie tous les fichiers, pas seulement les modifiés
--show-diff-on-failureAffiche le diff si un hook modifie des fichiers
--fail-fastArrête dès le premier échec
CommandeDescription
pre-commit installActive les hooks dans le dépôt
pre-commit runExécute sur les fichiers stagés
pre-commit run --all-filesExécute sur tout le dépôt
pre-commit run <hook-id>Exécute un hook spécifique
pre-commit autoupdateMet à jour les versions des hooks
pre-commit cleanSupprime le cache des environnements
pre-commit gcNettoie les repos non utilisés
pre-commit uninstallDésactive les hooks
pre-commit validate-configValide la syntaxe du fichier config
pre-commit try-repo <url>Teste un hook sans l’installer

Dans de rares cas, vous pouvez avoir besoin de passer outre les hooks :

Fenêtre de terminal
# Ignorer tous les hooks
git commit --no-verify -m "WIP: work in progress"
# Ignorer un hook spécifique (via variable d'environnement)
SKIP=trailing-whitespace git commit -m "Keep trailing spaces"

Par défaut, les hooks s’exécutent au pre-commit. Vous pouvez configurer d’autres moments :

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-added-large-files
stages: [pre-commit, pre-push]
StageMomentCas d’usage
pre-commitAvant le commitFormatage, linting rapide
pre-pushAvant le pushTests longs, scans de sécurité
commit-msgAprès saisie du messageValidation format commit
post-checkoutAprès checkoutMise à jour dépendances

Pour activer plusieurs stages :

Fenêtre de terminal
pre-commit install --hook-type pre-commit --hook-type pre-push
SymptômeCauseSolution
”command not found: pre-commit”pipx pas dans le PATHpipx ensurepath puis relancer le shell
Hook très lent au premier runTéléchargement des environnementsNormal, le cache accélère les runs suivants
Erreur “not a git repository”Pas de dépôt Gitgit init d’abord
Hook échoue en CI mais pas en localVersions différentesUtiliser pre-commit autoupdate
”No .pre-commit-config.yaml”Fichier absentCréer le fichier à la racine
  1. pre-commit = garde-fou automatique — Vérifie le code avant qu’il n’atteigne le dépôt
  2. Installation : pipx install pre-commit puis pre-commit install dans chaque projet
  3. Configuration : fichier .pre-commit-config.yaml à la racine
  4. Mise à jour : pre-commit autoupdate pour utiliser les dernières versions
  5. CI/CD : ajouter pre-commit run --all-files dans le pipeline
  6. Hooks essentiels : trailing-whitespace, check-yaml, detect-private-key, gitleaks
  7. Contournement : git commit --no-verify (à éviter)

Ce site vous est utile ?

Sachez que moins de 1% des lecteurs soutiennent ce site.

Je maintiens +700 guides gratuits, sans pub ni tracing. Aujourd'hui, ce site ne couvre même pas mes frais d'hébergement, d'électricité, de matériel, de logiciels, mais surtout de cafés.

Un soutien régulier, même symbolique, m'aide à garder ces ressources gratuites et à continuer de produire des guides de qualité. Merci pour votre appui.