Skip to content

Git Hook — автоматическое обновление

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


Установка

Ctrl+Shift+P → Викикод: Установить Git Hook

Нажмите «Установить» в появившемся диалоге. Готово.

Требование: Python 3 должен быть установлен на вашем компьютере.


Как это работает

  1. Вы делаете git commit как обычно
  2. Викикод автоматически определяет, какие файлы изменились
  3. Документация для этих файлов обновляется в фоне
  4. Коммит завершается мгновенно — ничего не блокируется

Управление

Если hook уже установлен, повторный запуск Викикод: Установить Git Hook предложит:

ДействиеОписание
Удалить hookОтключить автообновление
Показать содержимоеПосмотреть файл hook
ПереустановитьОбновить после смены аккаунта или истечения ключа

Безопасность

  • Ключ авторизации хранится только в файле hook внутри .git/ — этот каталог никогда не попадает в git-репозиторий
  • Ключ действителен 1 год, после чего нужно переустановить hook
  • Содержимое файлов передаётся по зашифрованному соединению
  • На сервере сохраняется только сгенерированная документация, не исходный код

Устранение неполадок

Hook не срабатывает после коммита

  1. Проверьте наличие Python 3: python3 --version
  2. Переустановите hook через команду Викикод: Установить Git HookПереустановить

Документация не обновляется

  1. Убедитесь, что файл имеет поддерживаемый тип (.ts, .js, .py, .go, .rs, .java и др.)
  2. Проверьте, что проект был проинициализирован — выполните глубокое сканирование хотя бы один раз
  3. Если ключ мог истечь — переустановите hook

В проекте уже есть post-commit hook

При установке Викикод создаёт резервную копию существующего hook. При удалении — восстанавливает его автоматически.

Документация Викикод