При работе с системами контроля версий, такими как Git, крайне важно обеспечить качество и согласованность кодовой базы. Один из способов добиться этого — запустить инструменты проверки работоспособности кода перед фиксацией. В этой статье мы рассмотрим пять различных методов настройки репозитория Git для автоматического запуска этих инструментов, а также приведем примеры кода для каждого подхода.

1. Хуки Git:
   Хуки Git — это сценарии, которые Git выполняет до или после определенных событий, таких как фиксация кода. Используя перехватчики перед фиксацией, мы можем обеспечить проверку работоспособности кода перед разрешением фиксации. Вот пример настройки перехватчика предварительной фиксации:

#!/bin/sh
# Run code sanity checking tool
./code_sanity_checker.sh
# If the sanity check fails, prevent the commit
if [ $? -ne 0 ]; then
    echo "Code sanity check failed. Please fix the issues before committing."
    exit 1
fi

2. Атрибуты Git.
   Атрибуты Git позволяют вам определить собственное поведение для определенных файлов или типов файлов. Связав шаблон файла со сценарием или командой, вы можете автоматически запускать инструмент проверки работоспособности кода перед внесением изменений в указанный тип файла. Вот пример:

Создайте файл .gitattributesв корне вашего репозитория:

*.js  filter=code_sanity_checker

Настройте Git для использования инструмента проверки работоспособности кода:

git config --local filter.code_sanity_checker.clean ./code_sanity_checker.sh

3. Среды предварительной фиксации Git.
   Некоторые платформы предварительной фиксации упрощают настройку и управление перехватчиками Git. Одним из популярных вариантов является платформа pre-commit. Он предоставляет простой файл конфигурации, в котором вы можете указать инструменты проверки работоспособности кода для запуска. Вот пример файла .pre-commit-config.yaml:

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
  rev: v4.0.1
  hooks:
  - id: trailing-whitespace

Установите платформу предварительной фиксации:

pip install pre-commit

Запустите проверку работоспособности кода:

pre-commit run --all-files

4. GitLab CI/CD:
   Если вы используете GitLab для своего репозитория, вы можете использовать его встроенные возможности непрерывной интеграции и непрерывного развертывания (CI/CD). Настраивая конвейер CI/CD GitLab, вы можете определить этапы и задания, которые выполнят проверку работоспособности кода, прежде чем разрешить фиксацию кода. Вот пример конфигурации .gitlab-ci.yml:

stages:
  - code_sanity_check
code_sanity_check:
  stage: code_sanity_check
  script:
    - ./code_sanity_checker.sh

5. Действия GitHub.
   Для репозиториев GitHub вы можете использовать действия GitHub для автоматизации проверки работоспособности кода. Определив файл конфигурации рабочего процесса, вы можете выполнять проверки работоспособности кода для каждого запроса push или pull. Вот пример файла .github/workflows/code_sanity_check.yml:

name: Code Sanity Check
on:
  push:
    branches:
      - main
jobs:
  code_sanity_check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
      - name: Run code sanity checker
        run: ./code_sanity_checker.sh

Настроив Git для запуска инструментов проверки работоспособности кода перед коммитом, вы можете обеспечить качество и согласованность своей кодовой базы. В этой статье мы рассмотрели пять различных методов, включая перехватчики Git, атрибуты Git, платформы предварительной фиксации, GitLab CI/CD и действия GitHub. Выберите подход, который лучше всего соответствует потребностям вашего проекта, и начните автоматизировать проверку работоспособности кода уже сегодня.