Skip to content

feat: add release flow to README.md #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yuberdysheva merged 3 commits into from
Mar 9, 2023
Merged

feat: add release flow to README.md #183

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a054183
feat: add release flow to README.md
yuberdysheva Feb 28, 2023
27eaeae
feat: add info about commits
yuberdysheva Feb 28, 2023
13f3883
feat: add info about breaking changes
yuberdysheva Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,3 +225,21 @@ You can define environment variables for dev-mode in .env.development file withi
npm ci
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).
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/).

When you receive the approval of your pull-request from the code owners and pass all the checks, please do the following:
Copy link
Contributor

@gorgeousvlad gorgeousvlad Feb 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could add here some info about commit message format and it's relation with publishing version


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).