Git Hook — автоматическое обновление
Git Hook — рекомендуемый способ поддерживать документацию актуальной. После каждого git commit документация изменённых файлов обновляется автоматически, в фоне — коммит не блокируется.
Установка
Ctrl+Shift+P → Викикод: Установить Git HookНажмите «Установить» в появившемся диалоге. Готово.
Требование: Python 3 должен быть установлен на вашем компьютере.
Как это работает
- Вы делаете
git commitкак обычно - Викикод автоматически определяет, какие файлы изменились
- Документация для этих файлов обновляется в фоне
- Коммит завершается мгновенно — ничего не блокируется
Управление
Если hook уже установлен, повторный запуск Викикод: Установить Git Hook предложит:
| Действие | Описание |
|---|---|
| Удалить hook | Отключить автообновление |
| Показать содержимое | Посмотреть файл hook |
| Переустановить | Обновить после смены аккаунта или истечения ключа |
Безопасность
- Ключ авторизации хранится только в файле hook внутри
.git/— этот каталог никогда не попадает в git-репозиторий - Ключ действителен 1 год, после чего нужно переустановить hook
- Содержимое файлов передаётся по зашифрованному соединению
- На сервере сохраняется только сгенерированная документация, не исходный код
Устранение неполадок
Hook не срабатывает после коммита
- Проверьте наличие Python 3:
python3 --version - Переустановите hook через команду
Викикод: Установить Git Hook→Переустановить
Документация не обновляется
- Убедитесь, что файл имеет поддерживаемый тип (
.ts,.js,.py,.go,.rs,.javaи др.) - Проверьте, что проект был проинициализирован — выполните глубокое сканирование хотя бы один раз
- Если ключ мог истечь — переустановите hook
В проекте уже есть post-commit hook
При установке Викикод создаёт резервную копию существующего hook. При удалении — восстанавливает его автоматически.