Avete mai accidentalmente spinto i segreti in un repository?O forse avete spinto il codice non formattato, solo per dover creare un follow-up "linting" commit?Abbiamo tutti stato lì.Questi piccoli errori possono portare a pipelines CI / CD falliti e ritardi frustranti, tutto a causa di controlli che potrebbero essere stati eseguiti localmente. Git hooks sono uno strumento potente per prevenire questi problemi eseguendo script prima di impegnarsi o spingere. Pre-commit è un framework facile da usare per la gestione e la condivisione di git hooks multilingue, aiutandoti a catturare i problemi prima che abbiano persino lasciato la tua workstation. Come iniziare: l'installazione giusta Prima di poter sfruttare la potenza del pre-commit, è necessario installarlo e configurarlo per i vostri progetti. Installazione Ci sono diversi modi per installare pre-commit: 
 
 MacOS e Linux: brew install pre-commit
 
 
 Python/Pip (piattaforma di interconnessione): pip install pre-commit
 
 
 Altri metodi: per le installazioni utilizzando Conda o su Windows, si prega di consultare la documentazione ufficiale. Documentazione ufficiale Impostazione specifica del progetto (il modo standard) Questo è l'approccio più comune per consentire il pre-commit in un progetto specifico: 
 
 
 
 
 Create a Configuration File: In the root of your repository, create a file named  . This file will define the hooks pre-commit should run. (We’ll cover how to populate this file in the next section). .pre-commit-config.yaml 
 
 Install Hooks: Navigate to your repository’s root directory in your terminal and run: pre-commit install
 
 
 Questo comando installa i git hooks nella directory .git/hooks del tuo repository. Da ora in poi, pre-commit eseguirà automaticamente i suoi controlli prima di ogni commit che fai in questo repository specifico. Global Setup (il metodo “Set It and Forget It”) Se si avviano spesso nuovi progetti o si clonano repositori e si desidera che il pre-commit sia attivo per impostazione predefinita (se esiste una configurazione), è possibile configurarlo a livello globale. La caratteristica. init.templateDir 
 
 
 
 
 A Configuration File: All your repository must have a  . This file will define the hooks that pre-commit should run. The best would be to use a template repository with a minimal pre-commit file. .pre-commit-config.yaml 
 
 Configure Git’s Template Directory: Tell Git to use a specific directory as a template for new repositories: git config --global init.templateDir ~/.git-template
 (Puoi scegliere un directory diverso se preferisci, assicurati solo che sia coerente nel passo successivo.) Inizializzare Pre-commit nella directory Template: eseguire il seguente comando: pre-commit init-templatedir ~/.git-template
 (Se nel passaggio precedente hai selezionato un directory diverso, sostituisci di conseguenza) ~/.git-template Questo ha un grande vantaggio: con questa configurazione globale, qualsiasi nuovo repository che inizializzi ( ) o un clone avrà automaticamente installato l'accoppiamento di pre-commit. Se un repository non ha un file, pre-commit non farà semplicemente nulla, quindi è sicuro abilitare a livello globale. git init .pre-commit-config.yaml Tuttavia, mi piace andare un passo avanti aggiungendo un cappello predefinito che sarebbe sistematicamente fallito se un repository non avesse un Ecco il contenuto del hook. ~/.git-template/hooks/pre-commit .pre-commit-config.yaml #!/usr/bin/env bash
if [ -f .pre-commit-config.yaml ]; then
    echo 'pre-commit configuration detected, but `pre-commit install` was never run' 1>&2
    exit 1
fi
 Crea la tua configurazione (.pre-commit-config.yaml) Il cuore del pre-comitato è il Questo file, posizionato alla radice del tuo repository, dice pre-commit che controlla di eseguire. .pre-commit-config.yaml # https://github.com/xNok/infra-bootstrap-tools/blob/main/.pre-commit-config.yaml
repos:
  # Lint all yam files
  - repo: https://github.com/adrienverge/yamllint.git
    rev: v1.29.0
    hooks:
      - id: yamllint
  # Runs Ansible lint
  - repo: https://github.com/ansible/ansible-lint
    rev: v24.7.0
    hooks:
      - id: ansible-lint
        args:
          - "ansible"
        additional_dependencies:
          - ansible
 Struttura di base spiegata Una configurazione tipica comporta un elenco di repositori, ognuno con cavi specifici: 
 
 repos: Questa è una chiave di livello superiore che prende un elenco di mappe di repository. Ogni elemento nell'elenco specifica un repository Git che contiene hooks pre-commit. 
 
 repo: L'URL del repository che ospita i hooks (ad esempio, https://github.com/pre-commit/pre-commit-hooks). Questo è un modo molto bello per gestire le dipendenze. Quando si sa di più sullo strumento, si può andare al repository. 
 
 Rev: Specifica la versione dei ganci da usare, pining a un tag Git, SHA, o ramo. ma si consiglia di utilizzare sempre un tag specifico o SHA (non una rama come il master) per garantire che il vostro linting non si rompa inaspettatamente quando il repository remoto viene aggiornato. 
 
 Hooks: un elenco sotto ogni voce di repo. Ogni elemento qui definisce un hook specifico da utilizzare da quel repository. 
 
 id: l'identificatore univoco dell'acconciatura (ad es. trailing-whitespace, check-yaml). È possibile trovare gli ID dell'acconciatura disponibili nella documentazione del repository dell'acconciatura. o semplicemente il .pre-commit-hooks.yaml alla radice del repo. Una configurazione di avvio pratica Ecco una base Per questo esempio, ti consiglio di andare a Github e dare un'occhiata a Questo è l'elenco dei semplici hooks che il Il team ha implementato, e dove si può trovare il di ciascuno dei pertinenti hooks che potresti voler utilizzare. .pre-commit-config.yaml pre-commit/pre-commit-hooks/blob/main/.pre-commit-hooks.yaml pre-commit id pre-commit/pre-commit-hooks/blob/main/.pre-commit-hooks.yaml Io direi e Questo è molto utile, quindi la configurazione dovrebbe sembrare così. trailing-whitespace end-of-file-fixer repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0  # Check for the latest stable version on the pre-commit-hooks repo!
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
# Add other repositories and their specific hooks below
# -   repo: ...
#     rev: ...
#     hooks:
#     -   id: ...
 Nota: Le versioni per i hooks cambiano nel tempo. È una buona pratica controllare occasionalmente il repository (o qualsiasi altro repository di coda utilizzato) per l'ultimo tag di versione stabile e l'aggiornamento del Oppure avere l'automazione in atto, come Renovate o Dependabot, per aggiornarle regolarmente. pre-commit-hooks rev Puoi trovare un'ampia lista di hooks preesistenti sul Dalla mia esperienza, questo elenco è ben lungi dall’essere esaustivo; invece, preferisco controllare gli strumenti che mi piacciono di utilizzare. Vediamo se ci sono dei hooks disponibili. Sito web pre-commit .pre-commit-hooks.yaml Sito web pre-commit Buono da sapere quando usare pre-commit Una volta che sei a tuo agio con i fondamenti, pre-commit offre funzionalità più avanzate per raffinare il tuo flusso di lavoro. Giocare con i hooks manualmente Mentre i hooks vengono eseguiti automaticamente , potresti voler attivarli manualmente in altri momenti: git commit 
 
 Eseguire una coda specifica: per eseguire una singola coda (ad esempio, per testare la sua configurazione o applicare le sue modifiche senza impegnarsi), utilizzare: pre-commit run <hook_id>
 (sostituzione con l'ID reale dal file di configurazione.) <hook_id> 
 
 Eseguire su tutti i file: per eseguire tutti i hacks configurati su ogni file tracciato nel vostro repository (non solo le modifiche in fase), usare: pre-commit run --all-files
 Questo è utile per una pulizia iniziale o quando si aggiungono nuovi chiodi a un progetto esistente. Crea i tuoi hooks locali A volte, potresti avere script o controlli specifici per il progetto che non fanno parte di un repository di coccole pubbliche. Pre-commit consente di definire coccole "locali". 
 
 
 Scrivi il tuo script: Crea il tuo script (ad esempio, uno script shell, uno script Python) nel tuo repository. Per questo esempio, diciamo che hai creato my_custom_script.sh. Definisci in .pre-commit-config.yaml: Aggiungi un'entrata di collegamento locale alla tua configurazione: # .pre-commit-config.yaml
-   repo: local
    hooks:
    -   id: my-custom-check
        name: My custom check
        entry: ./my_custom_script.sh # Path to your script
        language: script             # Or python, node, etc.
        files: \.(py)$               # Example: regex to run only on Python files
        # verbose: true              # Uncomment for more output
        # args: [--custom-arg]       # Optional arguments for your script
 Questo dice pre-commit a correre per qualsiasi modifica in Python ( Il file, il Tipo è molto flessibile; per ambienti specifici come Python o Node, è possibile specificare quelli per gestire le dipendenze se necessario. di Hooks. my_custom_script.sh .py language: script bash Tuttavia, pre-commit è molto intelligente per quanto riguarda gli ambienti di lavoro, in quanto crea un ambiente di runtime isolato per gli strumenti e le dipendenze richieste. Non tutti i ganci, purtroppo, hanno sfruttato la funzione di dipendenza, e potresti dover installare gli strumenti da solo per poter eseguire il gancio (penso alla terraform, per esempio) Pre-Commit in un team e CI / CD Ambiente Mentre il pre-commit risplende sulle singole macchine sviluppatrici, i suoi vantaggi si moltiplicano quando integrati nei flussi di lavoro del team e nei pipeline CI/CD. Anche con i pre-commit hooks installati localmente, qualcuno potrebbe accidentalmente impegnarsi senza i hooks (ad esempio, utilizzando ) o avere una configurazione di chiusura obsoleta. Il tuo pipeline CI / CD può agire come il gatekeeper ultimo. git commit --no-verify Eseguendo i controlli pre-commit nella pipeline CI, si assicura che nessun codice che violi gli standard del progetto venga unito. pre-commit run --all-files
 Questo comando controlla tutti i file nel repository, non solo quelli modificati, garantendo una convalida completa. Conceptual CI Pipeline Step (ad esempio, azioni GitHub): # Example for a GitHub Actions workflow
# ... (other steps like checkout, setup python/node, etc.)
- name: Install pre-commit and dependencies
  run: |
    pip install pre-commit
    # Install any other dependencies your hooks might need (e.g., linters)
    # This might be minimal if your hooks install their own dependencies (common).
- name: Run pre-commit checks
  run: pre-commit run --all-files
 È bello avere un pipeline concettuale che funzioni con qualsiasi sistema CI, ma se si utilizzano le azioni di GitHub, non c'è bisogno di preoccuparsi; usare il . azione ufficiale jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-python@v3
    - uses: pre-commit/action@v3.0.1
 Con l'integrazione CI, il ciclo viene completato e la stessa convalida viene applicata negli ambienti di sviluppo come nell'ambiente CI. Se il pipeline fallisce, risolverlo localmente eseguendo pre-commit. Conclusione Realizzare qui per essere un modo migliore rispetto ai controlli manuali e alle "oops", abbiamo esplorato come Trasforma il tuo workflow di sviluppo. ha pre-commit Attraverso l’automazione dei controlli su tutto, dai errori di spazio bianco alla rilevazione segreta alla formattazione del codice e all’involucro, pre-commit agisce come il vostro incrollabile custode locale della qualità del codice che può perfino integrarsi “sensibilmente” nei pipeline CI/CD per servire da gateway di qualità finale.

Read My Stories

Questo audio è prodotto nella lingua originale della storia!

La tua prima linea di difesa per il codice pulito è Pre-Commit: come impostarlo

About Author

COMMENTI

CARTELLINI

QUESTO ARTICOLO È STATO PRESENTATO IN

Related Stories

New Year, New Exciting Features: Mint Your Name, Watch Web 2.5 and Meet The Top Startups of The Year

Netflix Brings Out the Big Guns

HackerNoon - A User Experience Analysis: Part 2

Arron Goolsbey Talks Future of Gaming with AI and Blockchain at Mythical Games

New Year, New Exciting Features: Mint Your Name, Watch Web 2.5 and Meet The Top Startups of The Year

Netflix Brings Out the Big Guns

HackerNoon - A User Experience Analysis: Part 2

Arron Goolsbey Talks Future of Gaming with AI and Blockchain at Mythical Games

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps