From a054183747d6928319bffe3b2b8b617d65e36004 Mon Sep 17 00:00:00 2001 From: Juli Ovechkina Date: Tue, 28 Feb 2023 16:44:33 +0300 Subject: [PATCH 1/3] feat: add release flow to README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d76268a42..deb5ba7d7 100644 --- a/README.md +++ b/README.md @@ -225,3 +225,12 @@ You can define environment variables for dev-mode in .env.development file withi npm ci npm run dev ``` + +## Release flow + +When you receive the approval of your pull-request from the code owners and pass all the checks, please do the following: + +1. Squash and merge your PR (It is important to release a new version with Github-Actions) +2. Wait until robot creates a PR with a new version of the package and information about your changes in CHANGELOG.md. You can see the process on [the Actions tab](https://github.com/gravity-ui/page-constructor/actions). +3. Check your changes in CHANGELOG.md and approve robot's PR. +4. Squash and merge PR. You can see release process on [the Actions tab](https://github.com/gravity-ui/page-constructor/actions). From 27eaeaeb2f313be89faafce99a8ad21f7fc0f96a Mon Sep 17 00:00:00 2001 From: Juli Ovechkina Date: Tue, 28 Feb 2023 19:03:24 +0300 Subject: [PATCH 2/3] feat: add info about commits --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index deb5ba7d7..b45f7c80b 100644 --- a/README.md +++ b/README.md @@ -228,9 +228,17 @@ npm run dev ## Release flow +In usual cases we use two types of commits: + +1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning). +2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning). + +You can see all information [here](https://www.conventionalcommits.org/en/v1.0.0/). + When you receive the approval of your pull-request from the code owners and pass all the checks, please do the following: -1. Squash and merge your PR (It is important to release a new version with Github-Actions) -2. Wait until robot creates a PR with a new version of the package and information about your changes in CHANGELOG.md. You can see the process on [the Actions tab](https://github.com/gravity-ui/page-constructor/actions). -3. Check your changes in CHANGELOG.md and approve robot's PR. -4. Squash and merge PR. You can see release process on [the Actions tab](https://github.com/gravity-ui/page-constructor/actions). +1. You should check if there is a release pull-request from robot with changes from another contributor (it looks like `chore(main): release 0.0.0`). If it exists, you should check why it is not merged. If the contributor agrees to release a shared version, follow the next step. If not, ask him to release his version, then follow the next step. +2. Squash and merge your PR (It is important to release a new version with Github-Actions) +3. Wait until robot creates a PR with a new version of the package and information about your changes in CHANGELOG.md. You can see the process on [the Actions tab](https://github.com/gravity-ui/page-constructor/actions). +4. Check your changes in CHANGELOG.md and approve robot's PR. +5. Squash and merge PR. You can see release process on [the Actions tab](https://github.com/gravity-ui/page-constructor/actions). From 13f3883828c2cfce24f893e07776499f278f5906 Mon Sep 17 00:00:00 2001 From: Juli Ovechkina Date: Tue, 28 Feb 2023 19:05:57 +0300 Subject: [PATCH 3/3] feat: add info about breaking changes --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b45f7c80b..3aad48103 100644 --- a/README.md +++ b/README.md @@ -232,6 +232,7 @@ In usual cases we use two types of commits: 1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning). 2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning). +3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. You can see all information [here](https://www.conventionalcommits.org/en/v1.0.0/).