Skip to content
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

Jump to bottom

Update releases.md docs for update version workflow #1571

Merged
merged 2 commits into from
Feb 27, 2021
Merged

Update releases.md docs for update version workflow #1571

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d03be8
Update releases.md
talyguryn Feb 26, 2021
eabbe34
Update docs/releases.md
talyguryn Feb 26, 2021
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
19 changes: 19 additions & 0 deletions docs/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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.

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),
you can close the pull request generated by the workflow.

Expand Down