mirror of
https://github.com/codex-team/editor.js
synced 2024-05-17 05:46:46 +02:00
Update releases.md docs for update version workflow (#1571)
* Update releases.md If the next update is planned to raise the minor version (`2.19.1` -> `2.20.0`), then change it before version update merge. * Update docs/releases.md Co-authored-by: Peter Savchenko <specc.dev@gmail.com> Co-authored-by: Peter Savchenko <specc.dev@gmail.com>
This commit is contained in:
parent
970d64efda
commit
1772edf912
|
@ -58,8 +58,27 @@ After each PR merge to the `next` branch [bump-version-on-merge-next.yml](.githu
|
||||||
workflow will check if a package version was updated. If there is no update then it will open a new PR with a next
|
workflow will check if a package version was updated. If there is no update then it will open a new PR with a next
|
||||||
prerelease version.
|
prerelease version.
|
||||||
|
|
||||||
|
### How it works
|
||||||
|
|
||||||
|
The command for bumping a version will be running in a workflow.
|
||||||
|
|
||||||
|
`yarn version --prerelease --preid rc --no-git-tag-version`
|
||||||
|
|
||||||
|
Prerelease version will be bumped or a new prerelease patch will be created:
|
||||||
|
|
||||||
|
- `2.19.1` -> `2.19.2-rc.0`
|
||||||
|
- `2.19.2-rc.0` -> `2.19.2-rc.1`
|
||||||
|
|
||||||
|
### Change version
|
||||||
|
|
||||||
You can edit version (and PR name of course) if you need to publish not a pre-release version or any other.
|
You can edit version (and PR name of course) if you need to publish not a pre-release version or any other.
|
||||||
|
|
||||||
|
If the next update is planned to raise the minor version (`2.19.1` -> `2.20.0`), then change it before version update merge.
|
||||||
|
|
||||||
|
- `2.19.1` will be bumped to `2.19.2-rc.0` be default, change `2.19.2-rc.0` to `2.20.0-rc.0`
|
||||||
|
|
||||||
|
### Ignore update
|
||||||
|
|
||||||
If you do not need to upgrade and publish the update with the merged pull request (docs update or any other non-important changes),
|
If you do not need to upgrade and publish the update with the merged pull request (docs update or any other non-important changes),
|
||||||
you can close the pull request generated by the workflow.
|
you can close the pull request generated by the workflow.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue