Présentation des hooks Git

  • 3 minutes

Les hooks Git peuvent changer la manière dont les équipes abordent la qualité du code, la sécurité et le suivi des règles de l'entreprise. Au lieu de vérifier ces éléments plus loin dans le processus, les hooks Git permettent aux équipes d’ajouter des vérifications automatiques directement dans le flux de travail de développement. Cela crée des normes de qualité qui fonctionnent automatiquement entre les équipes et les projets.

Pourquoi l’automatisation importe

Le développement logiciel moderne a besoin d’une automatisation qui fonctionne précisément à chaque étape. Les hooks Git fournissent la base de cette automatisation. Ils permettent aux équipes d’implémenter des contrôles de qualité, des validations de sécurité et la conformité des règles qui s’exécutent automatiquement sans ralentir les développeurs.

  • Examinez les problèmes précoces : les hooks Git aident les équipes à utiliser des stratégies « shift-left » qui interceptent les problèmes le plus tôt possible. Cela réduit le coût de résolution des problèmes et améliore la qualité globale des logiciels.
  • Premier modèle de sécurité : dans les environnements métier, les hooks Git fonctionnent en tant que gardes de sécurité automatiques. Ils vérifient chaque modification de code par rapport aux stratégies de sécurité avant de les autoriser à poursuivre le processus de développement.
  • Vérification automatique des règles : pour les entreprises qui doivent respecter des réglementations strictes, les crochets Git fournissent un contrôle de conformité automatique. Cela garantit que chaque modification de code répond aux normes nécessaires sans nécessiter de révision manuelle.

Hooks sur les ordinateurs des développeurs

Les hooks côté client s’exécutent sur l’ordinateur de chaque développeur. Ils fournissent des commentaires immédiats et empêchent le code incorrect d’entrer des référentiels de code partagé.

Fonctionnalités du hook de pré-commit

  • Vérifications de la qualité du code : vérifiez automatiquement la mise en forme du code, les règles de linting et les normes de codage d’entreprise avant d’autoriser les validations.
  • Analyse de la sécurité : exécutez des analyses de sécurité automatiques pour rechercher des mots de passe, des clés API et des dépendances vulnérables avant d’entrer le code.
  • Test en cours d’exécution : exécutez des suites de test spécifiques pour vous assurer que les modifications de code ne interrompent pas les fonctionnalités existantes.
  • Vérifications de la documentation : vérifiez que les modifications de code incluent les mises à jour de documentation appropriées et conservent les normes de documentation.

Automatisation du hook de message de commit

  • prepare-commit-msg : créez ou modifiez automatiquement des messages de validation pour garantir la cohérence avec les normes de l’entreprise et inclure les informations nécessaires.
  • commit-msg : vérifiez le format du message de validation, imposez les règles de nommage et garantissez des liens appropriés vers des éléments de tâche ou des systèmes de suivi des problèmes.

Fonctionnalités d’intégration après le commit

  • Automatisation des notifications : envoyez des notifications automatiques aux membres de l’équipe, aux systèmes de gestion de projet ou aux plateformes de collaboration.
  • Création de la documentation : mettez automatiquement à jour la documentation du projet, les références d'API ou les journaux de modification à partir du contenu de commit.
  • Collecte des métriques : rassemblez les métriques de développement et l’analytique pour prendre en charge les efforts d’amélioration continue.

Modèles d’implémentation de hook avancés

Stratégies de raccordement axées sur la sécurité

Détection de mot de passe et de secret :

#!/bin/bash
# Check for passwords and secrets in code changes
if git diff --cached --name-only | xargs grep -l -E "(password|secret|api[_-]?key|token|credential)" 2>/dev/null; then
    echo "Security Alert: Found potential passwords or secrets in your changes"
    echo "Please review and remove sensitive information before committing"
    exit 1
fi

Vérification des dépendances vulnérables :

#!/bin/bash
# Check for security vulnerabilities in dependencies
if command -v npm &> /dev/null && [ -f package.json ]; then
    npm audit --audit-level=high
    if [ $? -ne 0 ]; then
        echo "Found security vulnerabilities in dependencies"
        echo "Please fix high-severity vulnerabilities before committing"
        exit 1
    fi
fi

Automatisation des scripts de vérification de la qualité

Vérification complète de la qualité du code :

#!/bin/bash
# Check code quality for multiple programming languages
for file in $(git diff --cached --name-only --diff-filter=ACM); do
    case "$file" in
        *.js|*.ts)
            npx eslint "$file" || exit 1
            ;;
        *.py)
            python -m flake8 "$file" || exit 1
            python -m mypy "$file" || exit 1
            ;;
        *.cs)
            dotnet format --verify-no-changes --include "$file" || exit 1
            ;;
    esac
done

Stratégie d’exécution de test automatique :

#!/bin/bash
# Smart test running based on what changed
changed_files=$(git diff --cached --name-only)
if echo "$changed_files" | grep -q "src/"; then
    echo "Running unit tests for changed components..."
    npm test -- --findRelatedTests $changed_files
    if [ $? -ne 0 ]; then
        echo "Tests failed. Please fix failing tests before committing"
        exit 1
    fi
fi

Intégration à des outils de développement

Intégration d’Azure DevOps

Vérification des liens d’élément de travail :

#!/bin/bash
# Make sure commit messages include Azure DevOps work item references
commit_message=$(cat "$1")
if ! echo "$commit_message" | grep -qE "#[0-9]+|AB#[0-9]+"; then
    echo "Commit message must reference a work item (e.g., #1234 or AB#1234)"
    exit 1
fi

Vérification du nom de la branche :

#!/bin/bash
# Check branch naming rules align with Azure DevOps policies
current_branch=$(git branch --show-current)
if ! echo "$current_branch" | grep -qE "^(feature|bugfix|hotfix)/[a-z0-9-]+$"; then
    echo "Branch name must follow convention: feature/description, bugfix/description, or hotfix/description"
    exit 1
fi

Automatisation de l’intégration du pipeline

Note

Vous devez installer l’extension Azure DevOps CLI pour utiliser ces commandes.

Déclencheurs de validation de build :

#!/bin/bash
# Trigger Azure Pipelines validation builds for significant changes
if git diff --cached --name-only | grep -qE "\.(cs|js|ts|py)$"; then
    echo "Triggering validation build for code changes..."
    az pipelines build queue --definition-name "PR-Validation" --branch $(git branch --show-current)
fi

Catégories de points d'accroche et cas d’usage

Automatisation des portes de qualité

Portails de qualité pré-commit :

  • Mise en forme du code et vérification du style
  • Analyse statique et linting
  • Test unitaire en cours d’exécution pour le code modifié
  • Vérification de l’exhaustivité de la documentation
  • Vérification de l’impact sur les performances

Validation préalable avant envoi :

  • Test d’intégration en cours d’exécution
  • Analyse des vulnérabilités de sécurité
  • Vérification de la conformité des licences de dépendances
  • Validation de build et création d’artefacts
  • Vérification de la préparation du déploiement

Automatisation de la sécurité et de la conformité

Implémentation du hook de sécurité :

  • Détection de mot de passe et de secret
  • Vérification des vulnérabilités des dépendances
  • Validation du modèle de sécurité du code
  • Vérification des règles de conformité
  • Création d’une piste d’audit

Crochets de validation de conformité :

  • Vérification des exigences réglementaires
  • Signature et vérification du code
  • Modification de la validation d’approbation
  • Vérification des conditions requises pour la documentation
  • Création du journal d’audit

Amélioration du flux de travail de développement

Optimisation de l’expérience des développeurs :

  • Création automatique d’un message de validation
  • Vérification des règles d’affectation de noms de branche
  • Automatisation de la liaison d’éléments de travail
  • Automatisation des affectations de révision de code
  • Suivi et création de rapports de progression

Amélioration de la collaboration d’équipe :

  • Automatisation des notifications et des communications
  • Aide au partage de connaissances
  • Collecte et création de rapports de métriques
  • Surveillance de la conformité des processus
  • Collecte continue des données d’amélioration

Les hooks Git fournissent la base d’automatisation essentielle pour les équipes de développement. Ils aident les organisations à ajouter une qualité, une sécurité et une conformité directement dans le flux de travail de développement tout en gardant les développeurs productifs et heureux.