Журнал изменений production обновляется только при фактическом деплое/релизе в production — не на каждый Git-коммит. Один релиз обычно включает много коммитов. Каждая запись — новая статья в разделе «Журнал изменений production» с названием ГГГГ-ММ-ДД — Production-релиз.
Шаблон #
# ГГГГ-ММ-ДД — Production-релиз
Production-коммит:
`<git SHA>`
## Изменено
- ...
## Исправлено
- ...
## Примечания
- ...
## Документация
- ссылки на соответствующие статьи wiki
Чек-лист #
- Возьмите SHA, который реально работает:
git -C /root/signage-estimator rev-parse HEAD— после того как деплой проверен. - Сведите коммиты с прошлой записи:
git log --oneline <предыдущий-sha>..<sha>. - Переимпортируйте документацию из Git на этом SHA (
import_git_docs.py --commit <sha>) и сошлитесь на затронутые статьи. - По возможности добавьте английскую версию записи и свяжите её как перевод.
Записей пока нет: первая появится при следующем production-деплое.