From bd184150ca5d9e60c0e1f6233d5f808f29b8fa63 Mon Sep 17 00:00:00 2001 From: Max Eliseev Date: Tue, 22 Nov 2022 20:01:50 +0700 Subject: [PATCH] =?UTF-8?q?docs:=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5?= =?UTF-8?q?=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D1=8F=20=D0=BF=D0=BE=20=D0=BD?= =?UTF-8?q?=D0=BE=D0=B2=D0=BE=D0=B9=20=D1=81=D0=B8=D1=81=D1=82=D0=B5=D0=BC?= =?UTF-8?q?=D0=B5=20=D1=80=D0=B5=D0=BB=D0=B8=D0=B7=D0=BE=D0=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/guides.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/guides.md b/docs/guides.md index 07a4534..ba019a6 100644 --- a/docs/guides.md +++ b/docs/guides.md @@ -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`