Skip to content

Commit 1772edf

Browse files
talygurynneSpecc
andauthored
Update releases.md docs for update version workflow (codex-team#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 <[email protected]> Co-authored-by: Peter Savchenko <[email protected]>
1 parent 970d64e commit 1772edf

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/releases.md

+19
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,27 @@ After each PR merge to the `next` branch [bump-version-on-merge-next.yml](.githu
5858
workflow will check if a package version was updated. If there is no update then it will open a new PR with a next
5959
prerelease version.
6060

61+
### How it works
62+
63+
The command for bumping a version will be running in a workflow.
64+
65+
`yarn version --prerelease --preid rc --no-git-tag-version`
66+
67+
Prerelease version will be bumped or a new prerelease patch will be created:
68+
69+
- `2.19.1` -> `2.19.2-rc.0`
70+
- `2.19.2-rc.0` -> `2.19.2-rc.1`
71+
72+
### Change version
73+
6174
You can edit version (and PR name of course) if you need to publish not a pre-release version or any other.
6275

76+
If the next update is planned to raise the minor version (`2.19.1` -> `2.20.0`), then change it before version update merge.
77+
78+
- `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`
79+
80+
### Ignore update
81+
6382
If you do not need to upgrade and publish the update with the merged pull request (docs update or any other non-important changes),
6483
you can close the pull request generated by the workflow.
6584

0 commit comments

Comments
 (0)