Skip to content

Commit

Permalink
docs: документация по новой системе релизов
Browse files Browse the repository at this point in the history
  • Loading branch information
mxseev committed Nov 22, 2022
1 parent 6f1e151 commit bd18415
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@
4. Production сборка: `pnpm run build`

## Релиз новой версии

Для корректной работы системы релизов необходимо делать все коммиты согласно [Conventional commits](https://www.conventionalcommits.org), для этого в репозитории уже настроены [commitzen](https://github.com/commitizen/cz-cli) (`pnpm run commit`) и [commitlint](https://github.com/conventional-changelog/commitlint) (настроен git хук для автоматического запуска перед коммитом).

В репозитории настроен Github Action [release-please](https://github.com/googleapis/release-please), который автоматически бампает версию пакета, генерирует changelog и создает Github релизы. После каждого пуша в `main` ветку, он автоматически создаст/обновит PR, в котором будет:
- обновленный changelog
- бампнутая версия пакета

Как только релиз готов необходимо смержить этот PR, после чего произойдет публикация Github релиза.

1. Закоммитить изменения согласно [Conventional commits](https://www.conventionalcommits.org)
2. Проверить код: `pnpm run lint && pnpm run test`
3. Запушить созданный changelog: `git push`
Expand Down

0 comments on commit bd18415

Please sign in to comment.