feat: add release flow to README.md #183
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Preview is ready. |
Lakate
approved these changes
Feb 28, 2023
NikitaCG
reviewed
Feb 28, 2023
README.md
Outdated
| 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). |
Collaborator
There was a problem hiding this comment.
There is a case when the release PR is already there. You can describe it with a sub-item. For example, if there is already a release PR and no one likes it, then there are not particularly urgent changes, but just in case you can check with other contributors whether they agree to release a new version
NikitaCG
reviewed
Feb 28, 2023
README.md
Outdated
| 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). |
Collaborator
There was a problem hiding this comment.
how to mark `breaking changes' and how to release a major?
Contributor
Author
There was a problem hiding this comment.
Agreed to write about patch and minor only
|
|
||
| ## Release flow | ||
|
|
||
| When you receive the approval of your pull-request from the code owners and pass all the checks, please do the following: |
Contributor
There was a problem hiding this comment.
I think we could add here some info about commit message format and it's relation with publishing version
NikitaCG
approved these changes
Mar 3, 2023
gorgeousvlad
approved these changes
Mar 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.