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.

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

Release v2.6.0 #6

Merged
merged 1 commit into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions contrib/charts/gubernator/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ description: A Helm Chart for gubernator

type: application

version: 2.5.0
version: 2.6.0

appVersion: 2.5.0
appVersion: 2.6.0
22 changes: 10 additions & 12 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ This document explains the release process for when a new version must be
published.

At a high level:
* Merge PR to `master`.
* Then, update version files in `master`.
* Finally, publish GitHub Release.
* Merge PR's included in this release to `master`.
* Create a release PR called `release-MAJOR-MINOR-PATCH`
* Update version files in with `./update-version.sh vMAJOR.MINOR.PATCH`
* Collaborate with other maintainers or self merge at your discretion
* Finally, publish GitHub Release

## Update Version Files
Some files contain the current version in [semver](https://semver.org/) format,
Expand All @@ -26,8 +28,6 @@ Use script `update-version.sh` to easily update the required files.
$ ./update-version.sh 2.0.0-rc.35
```

Commit and push directly to `master` branch.

## Publish New GitHub Release
Publish a GitHub release from github.com.

Expand All @@ -42,6 +42,8 @@ Provide a meaningful description of what's changed. For example:
* Updated foobar by @Baliedge in #999.
```

or use the `Generate Release Notes` button

Click "Publish Release".

Publishing will launch an `on-release` GitHub Action to do the following:
Expand All @@ -54,12 +56,8 @@ More details on publishing GitHub releases:
https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository.

## Version Consistency Check
The version consistency check is performed in both PR `on-pull-request` and
`on-release`. This will ensure the latest tag version matches the version
found in the files described in [Update Version Files](#update-version-files).
The version consistency check is performed `on-release`. This will ensure the latest
tag version matches the version found in the files described in [Update Version Files](#update-version-files).

If the check fails, the workflow will abort with an error. The developer can
make the necessary changes indicated in the error message.

Developers may call script `./check-version.sh` locally to verify changes
before commit.
make the necessary changes indicated in the error message.
2 changes: 1 addition & 1 deletion version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v2.5.0
v2.6.0
Loading