Ви коли-небудь випадково підштовхували секрети до сховища? Або, можливо, ви підштовхнули неформатований код, тільки щоб створити наступний "зв'язковий" компроміс?Ми всі були там. Ці невеликі помилки можуть призвести до невдалих трубопроводів CI / CD і фрустраційних затримок, все через перевірки, які могли бути проведені локально. Git-куки є потужним інструментом для запобігання цим проблемам, запускаючи скрипти, перш ніж домовлятися або натискати. Pre-commit - це легка у використанні рамка для управління та спільного використання багатомовних git-хаків, що допомагає вам зловити проблеми, перш ніж вони навіть залишать вашу робочу станцію. Початок: правильна установка Перш ніж ви можете скористатися силою попереднього зобов'язання, ви повинні встановити його і налаштувати його для своїх проектів. Інсталяція Є кілька способів встановити Pre-Commit: 
 
 MacOS і Linux: brew install pre-commit
 
 
 Python/Pip (крізь платформу) pip install pre-commit
 
 
 Інші методи: Для установки за допомогою Conda або на Windows, будь ласка, зверніться до Офіційної документації. Офіційна документація Специфічне налаштування проекту (Стандартний спосіб) Це найбільш поширений підхід до попереднього зобов'язання в конкретному проекті: 
 
 
 
 
 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
 
 
 Ця команда встановлює гайки git в каталог .git/hooks вашого репозиторію. З цього моменту, попередній договір буде автоматично виконувати свої перевірки перед кожним договір, який ви робите в цьому конкретному репозиторії. Глобальне налаштування (метод «Встановити і забути») Якщо ви часто запускаєте нові проекти або клонуєте сховища і хочете, щоб попереднє зобов'язання було активним за замовчуванням (якщо існує конфігурація), ви можете налаштувати його глобально. Особливості 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
 (Ви можете вибрати інший каталог, якщо ви хочете, просто переконайтеся, що він є послідовним у наступному кроці.) Ініціалізація Pre-commit в директорії шаблонів: Запустіть наступну команду: pre-commit init-templatedir ~/.git-template
 (Якщо ви обрали інший каталог в попередньому кроці, замініть Відповідно ) ~/.git-template Це має велику перевагу: за допомогою цього глобального налаштування будь-який новий репозиторій, який ви ініціалізуєте ( ) або клон автоматично буде мати встановлений гачок попереднього завдання. Якщо репозиторій не має файлу, попереднє зобов'язання просто нічого не робити, так що це безпечно, щоб увімкнути глобально. git init .pre-commit-config.yaml Тим не менш, мені подобається зробити ще один крок, додавши за замовчуванням гачок що систематично провалиться, якщо репозиторій не має Ось зміст хору. ~/.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
 Створення вашої конфігурації (.pre-commit-config.yaml) Основою попереднього завдання є Цей файл, розміщений у корені вашого сховища, розповідає про попередній договір, який перевіряє, щоб запустити. .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
 Основна структура пояснюється Типова конфігурація включає в себе список репозиторіїв, кожен з яких має певні хаки: 
 
 repos: це ключ верхнього рівня, який займає список мапірувань репозиторію. Кожен елемент в списку вказує репозиторій Git, який містить хаки попереднього завдання. 
 
 repo: URL-адреса репозиторію, на якому розміщуються хаки (наприклад, https://github.com/pre-commit/pre-commit-hooks). Це дуже хороший спосіб керувати залежностями. Коли ви знаєте більше про інструмент, ви можете звернутися до репозиторію. 
 
 rev: Він визначає версію хаків, які потрібно використовувати, підключившись до будь-якого тегу Git, SHA або філії. Але рекомендується завжди використовувати певний тег або SHA (не філії, як майстер), щоб переконатися, що ваша обкладинка не розривається несподівано, коли віддалений репозиторій оновлюється. 
 
 Hooks: Список під кожним записом репо. Кожен елемент тут визначає конкретний хак для використання з цього репозиторію. 
 
 id: Унікальний ідентифікатор куки (наприклад, trailing-whitespace, check-yaml). Ви можете знайти доступні ідентифікатори куки в документації репозиторію куки. або просто .pre-commit-hooks.yaml в корені репо. Практична стартова конфігурація Ось одна з основних Для цього прикладу, я рекомендую вам звернутися до Github і подивитися на Ось список простих гачок, які Використовується, і де ви можете знайти З кожної з відповідних гачок, які ви можете використовувати. .pre-commit-config.yaml Pre-commit / Pre-commit-hooks / Blob / Main / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks pre-commit id Pre-commit / Pre-commit-hooks / Blob / Main / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks / Pre-commit-hooks Я б сказав та Вони дійсно корисні, тому конфігурація буде виглядати так. 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: ...
 Примітка: версії для хоків змінюються з плином часу. Хороша практика іноді перевіряти репозиторію (або будь-який інший репозиторій, який ви використовуєте) для останньої теги стабільної версії та оновлення Або мати автоматизацію на місці, наприклад, Renovate або Dependabot, щоб регулярно оновлювати їх. pre-commit-hooks rev Ви можете знайти великий список існуючих хаків на З мого досвіду, цей список далеко не вичерпний; замість цього, я вважаю за краще перевірити інструменти, я люблю використовувати Давайте подивимося, чи є хокеї доступні. Сайт Pre-Commit .pre-commit-hooks.yaml Сайт Pre-Commit Що потрібно знати при використанні Pre-Commit Після того, як ви відчуєте себе комфортно з основи, попереднє зобов'язання пропонує більш просунуті функції для тонкого налаштування вашого робочого процесу. Використання хокею вручну Хоча хокеї автоматично запускаються на , ви можете спробувати запустити їх вручну в інші часи: git commit 
 
 Виконайте певний гачок: Щоб виконати єдиний гачок (наприклад, щоб перевірити його конфігурацію або застосувати його зміни без зобов'язання), використовуйте: pre-commit run <hook_id>
 (заміна з фактичним ідентифікатором з вашого файлу конфігурації.) <hook_id> 
 
 Виконайте на всіх файлах: Щоб запустити всі налаштовані хаки на кожний відслідковуваний файл у вашому репозиторії (не тільки стадіонні зміни), використовуйте: pre-commit run --all-files
 Це корисно для початкового очищення або при додаванні нових хаків до існуючого проекту. Створіть свій власний локальний хоук Іноді у вас можуть бути специфічні для проекту скрипти або чеки, які не є частиною публічного сховища зв'язків. 
 
 
 Напишіть свій скрипт: Створіть свій скрипт (наприклад, скрипт оболонки, скрипт Python) у своєму сховищі. Визначте в .pre-commit-config.yaml: Додайте місцевий запис з'єднання до вашої конфігурації: # .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
 Це говорить про попереднє зобов'язання бігти для будь-яких змін у Python ( Файли: The Тип дуже гнучкий; для конкретних середовищ, таких як Python або Node, ви можете вказати ті, щоб керувати залежностями, якщо це необхідно. Хокеїсти my_custom_script.sh .py language: script bash Тим не менш, попередні зобов'язання дуже розумні щодо робочих середовищ, оскільки вони створюють ізольоване середовище для робочого часу для інструментів та необхідних залежностей. Не всі гайки, на жаль, скористалися функцією залежності, і вам може знадобитися встановити інструменти самостійно, щоб мати можливість запустити гачок (я думаю про терраформ, наприклад) Попередні зобов'язання в команді та середовищі CI / CD У той час як попереднє зобов'язання сяє на окремих комп'ютерах розробників, його переваги помножуються при інтеграції в робочі процеси команд та трубопроводи CI/CD. Навіть при встановленні попереднього зобов'язання на місці, хтось може випадково вступити в зобов'язання без порушень (наприклад, використовуючи ) або мати застарілу конфігурацію гачка. Ваш CI / CD трубопровід може діяти як остаточний воротар. git commit --no-verify Запускаючи перевірки попереднього зобов'язання у вашому CI-провіднику, ви гарантуєте, що жоден код, який порушує стандарти вашого проекту, не буде злитий. pre-commit run --all-files
 Ця команда перевіряє всі файли в репозиторії, а не тільки змінені, забезпечуючи всебічну валідацію. Концептуальні кроки CI Pipeline (наприклад, дії 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
 Приємно мати концептуальний трубопровід, який працює з будь-якою системою CI, але якщо ви використовуєте дії GitHub, вам не потрібно турбуватися; використовуйте . Офіційні дії jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-python@v3
    - uses: pre-commit/action@v3.0.1
 При інтеграції CI цикл завершується, і така ж валідація застосовується в середовищах розробника, як і в середовищі CI. Висновок Усвідомлення там Для того, щоб бути кращим способом, ніж ручні перевірки та «опини», ми вивчили, як це відбувається. Трансформуйте свій робочий процес. має pre-commit Автоматизуючи перевірки на все, починаючи від помилок у білому просторі та секретного виявлення, до форматирування коду та обкладинки, попереднє зобов'язання діє як ваш невтомний локальний охоронець якості коду, який може навіть "бездоганно" інтегруватися в трубопроводи CI / CD, щоб служити остаточним портом якості.

Read My Stories

Це аудіо створено мовою оригіналу історії!

Ваша перша лінія захисту за чистим кодом - це попереднє зобов'язання: як його встановити

About Author

КОМЕНТАРІ

ПОВІСИТИ БИРКИ

ЦЯ СТАТТЯ БУЛА ПРЕДСТАВЛЕНА В

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps