Разбор перехватчиков Git

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

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

Каждый репозиторий Git содержит каталог .git/hooks. В нём находятся примеры скриптов хуков (обычно с расширением .sample).

Чтобы активировать хук, просто удалите расширение .sample и сделайте файл исполняемым. После этого Git будет запускать его в нужный момент.

• Расположение: .git/hooks/
• Файлы: скрипты оболочки (Bash, Python, Ruby и другие)
• Активация: переименовать и сделать исполняемым

Хуки Git делятся на два основных типа в зависимости от места выполнения:

• Клиентские хуки: выполняются на Вашем локальном компьютере (например, перед созданием фиксации или перебазированием). Они предназначены для автоматизации личного рабочего процесса и соблюдения локальных правил.
• Серверные хуки: выполняются на удалённом сервере Git (например, когда Вы отправляете код в общий репозиторий). Они обеспечивают соблюдение правил проекта для всех участников.

Хук pre-commit — один из самых распространённых клиентских хуков. Он выполняется *до* того, как Git официально создаст фиксацию.

Если скрипт pre-commit завершается с ненулевым кодом состояния, Git отменяет создание фиксации. Это удобно для таких задач, как:

• проверка стиля кода
• запуск модульных тестов
• проверка наличия больших файлов или конфиденциальных данных

Хук commit-msg выполняется *после* ввода сообщения фиксации, но *до* окончательного создания фиксации.

Этот хук полезен для проверки соответствия сообщений фиксаций определённым соглашениям или форматам. Например, он может проверить:

• начинается ли сообщение с ID задачи (например, [JIRA-123])
• не превышает ли длина сообщения установленный предел
• присутствуют ли определённые ключевые слова или отсутствуют ли они

Хук post-commit выполняется *сразу после* успешного создания фиксации.

В отличие от pre-commit или commit-msg, этот хук не может изменить результат создания фиксации. Его часто используют для отправки уведомлений или интеграции, например для:

• уведомления участников команды
• обновления инструмента управления проектами
• запуска сборки непрерывной интеграции (CI), хотя чаще для этого используются серверные хуки

Переходя к серверным перехватчикам, pre-receive выполняется до обновления любых ссылок (например, веток или тегов) в удалённом репозитории.

Этот перехватчик позволяет эффективно обеспечивать соблюдение важных правил репозитория, например:

• запрещать прямую отправку изменений в ветку main
• требовать, чтобы все фиксации были подписаны
• проверять личность автора фиксации

Если этот перехватчик завершает работу с ненулевым кодом, вся отправка изменений отклоняется.

Перехватчик post-receive запускается после того, как отправка изменений успешно обновила ссылки в удалённом репозитории.

Подобно post-commit, этот перехватчик не может отклонить отправку изменений. Обычно его используют для:

• запуска конвейеров CI/CD
• обновления внешних систем отслеживания задач
• отправки уведомлений команде по электронной почте
• развёртывания кода в промежуточной среде

Чтобы создать перехватчик, достаточно создать файл с именем перехватчика (например, pre-commit) в каталоге .git/hooks/. Давайте создадим самый простой вариант:

После создания сценария перехватчика необходимо сделать его исполняемым. Иначе Git не будет его запускать. Используйте в терминале команду chmod:

chmod +x .git/hooks/pre-commit

Теперь при каждой попытке создать фиксацию Git будет выполнять этот сценарий!

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

Вы сделали первый шаг в мощный мир перехватчиков Git!

• Перехватчики Git — это сценарии, автоматизирующие действия во время событий Git.
• Они находятся в каталоге .git/hooks/ вашего репозитория.
• Перехватчики бывают клиентскими (на локальном компьютере) и серверными (в удалённом репозитории).
• Такие важные перехватчики, как pre-commit и pre-receive, могут обеспечивать соблюдение правил, блокируя операции.
• Перехватчики post-commit и post-receive предназначены для уведомлений или интеграций после выполнения действий.

Далее мы рассмотрим практические примеры реализации отдельных перехватчиков!