Skip to content

Commit

Permalink
Merge pull request #6 from gubernator-io/thrawn/release-26
Browse files Browse the repository at this point in the history
Release v2.6.0
  • Loading branch information
thrawn01 authored Mar 26, 2024
2 parents b5893f5 + 6f7556f commit 5a461b4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 15 deletions.
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

0 comments on commit 5a461b4

Please sign in to comment.