Skip to content

Commit bd18415

Browse files
committed
docs: документация по новой системе релизов
1 parent 6f1e151 commit bd18415

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/guides.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@
88
4. Production сборка: `pnpm run build`
99

1010
## Релиз новой версии
11+
12+
Для корректной работы системы релизов необходимо делать все коммиты согласно [Conventional commits](https://www.conventionalcommits.org), для этого в репозитории уже настроены [commitzen](https://github.com/commitizen/cz-cli) (`pnpm run commit`) и [commitlint](https://github.com/conventional-changelog/commitlint) (настроен git хук для автоматического запуска перед коммитом).
13+
14+
В репозитории настроен Github Action [release-please](https://github.com/googleapis/release-please), который автоматически бампает версию пакета, генерирует changelog и создает Github релизы. После каждого пуша в `main` ветку, он автоматически создаст/обновит PR, в котором будет:
15+
- обновленный changelog
16+
- бампнутая версия пакета
17+
18+
Как только релиз готов необходимо смержить этот PR, после чего произойдет публикация Github релиза.
19+
1120
1. Закоммитить изменения согласно [Conventional commits](https://www.conventionalcommits.org)
1221
2. Проверить код: `pnpm run lint && pnpm run test`
1322
3. Запушить созданный changelog: `git push`

0 commit comments

Comments
 (0)