Introduktion till Git Hooks

  • 3 minuter

Git-krokar kan ändra hur team närmar sig kodkvalitet, säkerhet och följande företagsregler. I stället för att kontrollera dessa saker senare i processen kan Git-hooks låta team lägga till automatiska kontroller direkt i arbetsflödet för utveckling. Detta skapar kvalitetsstandarder som fungerar automatiskt mellan team och projekt.

Varför automatisering spelar roll

Modern programvaruutveckling behöver automatisering som fungerar exakt i varje skede. Git-krokar utgör grunden för den här automatiseringen. De låter team implementera kvalitetskontroller, säkerhetsvalidering och regelefterlevnad som körs automatiskt utan att göra utvecklarna långsammare.

  • Kontrollera problem tidigt: Git-krokar hjälper teamen att använda "shift-left"-strategier som identifierar problem i ett så tidigt skede som möjligt. Detta minskar kostnaderna för att åtgärda problem och förbättrar den övergripande programvarukvaliteten.
  • Säkerhetsmodell: I företagsmiljöer fungerar Git-krokar som automatiska säkerhetsvakter. De kontrollerar varje kodändring mot säkerhetsprinciper innan de kan fortsätta under utvecklingsprocessen.
  • Automatisk regelkontroll: För företag som måste följa strikta regler tillhandahåller Git-krokar automatisk efterlevnadskontroll. Detta säkerställer att varje kodändring uppfyller nödvändiga standarder utan att kräva manuell granskning.

Hooks på utvecklardatorer

Krokar på klientsidan körs på varje utvecklares dator. De ger omedelbar feedback och förhindrar att felaktig kod kommer in på lagringsplatser för delad kod.

Funktioner för pre-commit-hookar

  • Kvalitetskontroller av kod: Kontrollera automatiskt kodformatering, lintningsregler och företagets kodningsstandarder innan commits tillåts.
  • Säkerhetsgenomsökning: Kör automatiska säkerhetsgenomsökningar för att hitta lösenord, API-nycklar och sårbara beroenden innan de anger koden.
  • Testkörning: Kör specifika testpaket för att se till att kodändringar inte bryter befintliga funktioner.
  • Dokumentationskontroller: Kontrollera att kodändringar innehåller korrekta dokumentationsuppdateringar och underhåller dokumentationsstandarder.

Incheckning av meddelandekrokautomatisering

  • prepare-commit-msg: Skapa eller ändra incheckningsmeddelanden automatiskt för att säkerställa konsekvens med företagets standarder och inkludera nödvändig information.
  • commit-msg: Kontrollera formatet för kommentarmeddelanden, upprätthålla namngivningsregler och säkerställa att det finns korrekta länkar till arbetsobjekt eller ärendehanteringssystem.

Integreringsfunktioner efter commit

  • Meddelandeautomatisering: Skicka automatiska meddelanden till gruppmedlemmar, projekthanteringssystem eller samarbetsplattformar.
  • Skapande av dokumentation: Uppdatera projektdokumentation, API-referenser automatiskt eller ändra loggar baserat på incheckningsinnehåll.
  • Insamling av mått: Samla in utvecklingsmått och analys för att stödja kontinuerliga förbättringar.

Avancerade hookimplementeringsmönster

Säkerhetsfokuserade krokstrategier

Identifiering av lösenord och hemlighet:

#!/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

Söker efter sårbara beroenden:

#!/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

Automatisering av kvalitetskontrollkrokar

Slutför kodkvalitetskontroll:

#!/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

Strategi för automatisk testkörning:

#!/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

Integrering med utvecklingsverktyg

Azure DevOps-integrering

Kontroll av arbetsobjektlänkar:

#!/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

Kontroll av grennamn:

#!/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

Automatisering av pipeline-integrering

Anmärkning

Du måste installera Azure DevOps CLI-tillägget för att kunna använda dessa kommandon.

Skapa valideringsutlösare:

#!/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

Krokkategorier och användningsfall

Automatisering av kvalitetsgrind

Kvalitetsgrindar före incheckning:

  • Kodformatering och formateringskontroll
  • Statisk analys och lintning
  • Enhetstest som körs för ändrad kod
  • Kontroll av dokumentationens fullständighet
  • Kontroll av prestandapåverkan

Validering före push:

  • Integrationstest körs
  • Genomsökning av säkerhetsrisker
  • Efterlevnadskontroll av beroendelicenser
  • Byggvalidering och artefaktskapande
  • Kontroll av distributionsberedskap

Automatisering av säkerhet och efterlevnad

Implementering av säkerhetskrokar:

  • Identifiering av lösenord och hemlighet
  • Sårbarhetskontroll av beroenden
  • Validering av kodsäkerhetsmönster
  • Kontroll av efterlevnadsregel
  • Skapa revisionslogg

Efterlevnadsverifieringskrokar:

  • Kontroll av regelkrav
  • Kodsignering och verifiering
  • Validering av ändringsgodkännande
  • Kontroll av dokumentationskrav
  • Skapa granskningslogg

Förbättringar av arbetsflöden för utveckling

Optimering av utvecklarupplevelsen:

  • Automatisk skapande av incheckningsmeddelande
  • Regelkontroll för grennamngivning
  • Automatisering av länkning av arbetsobjekt
  • Automatisering av kodgranskningstilldelning
  • Förloppsspårning och rapportering

Förbättring av teamsamarbete:

  • Meddelande- och kommunikationsautomatisering
  • Hjälp om kunskapsdelning
  • Insamling och rapportering av mått
  • Övervaka processefterlevnad
  • Datainsamling för kontinuerlig förbättring

Git-krokar tillhandahåller den grundläggande automationsgrunden för utvecklingsteam. De hjälper organisationer att lägga till kvalitet, säkerhet och efterlevnad direkt i utvecklingsarbetsflödet samtidigt som utvecklarna blir produktiva och nöjda.