Skip to content

Commit

Permalink
Update Release instructions with chart readme version bump (#1639)
Browse files Browse the repository at this point in the history
* Update chart readme tags before the release so it is properly
  reflected in ArtifactHub
* Inline update of Yury's actual email address

Signed-off-by: Yury Tsarev <[email protected]>
  • Loading branch information
ytsarev committed Jul 18, 2024
1 parent 35fd999 commit cf882a1
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,11 @@ make demo DEMO_URL=https://failover.test.exampledns.tk DEMO_DEBUG=1

* Bump the version in `Chart.yaml`, see [example PR](https://github.com/k8gb-io/k8gb/pull/749). Make sure the
commit message starts with `RELEASE:`.
* In addition, bump the version in `chart/k8gb/README.md` to reflect correct version tags in artifacthub after
release, e.g.
```
chart/k8gb/README.md:![Version: v0.13.0](https://img.shields.io/badge/Version-v0.13.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.13.0](https://img.shields.io/badge/AppVersion-v0.13.0-informational?style=flat-square)
```
* Merge the Pull Request after the review approval (make sure the squash or rebase is used, merge commit will not trigger the release pipeline)
* At this point a DRAFT release will be created on GitHub. After the [automatic tag](https://github.com/k8gb-io/k8gb/actions/workflows/cut_release.yaml) & [release pipeline](https://github.com/k8gb-io/k8gb/actions/workflows/release.yaml)
have been successfully completed, you check the [release DRAFT](https://github.com/k8gb-io/k8gb/releases) and if it is OK, you click on the **"Publish release"** button.
Expand Down
2 changes: 1 addition & 1 deletion chart/k8gb/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ maintainers:
name: Jiri Kremser
- email: [email protected]
name: Michal Kuritka
- email: yury[email protected]
- email: yury@upbound.io
name: Yury Tsarev

annotations:
Expand Down
2 changes: 1 addition & 1 deletion chart/k8gb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A Helm chart for Kubernetes Global Balancer
| Dinar Valeev | <[email protected]> | |
| Jiri Kremser | <[email protected]> | |
| Michal Kuritka | <[email protected]> | |
| Yury Tsarev | <yury[email protected]> | |
| Yury Tsarev | <yury@upbound.io> | |

## Source Code

Expand Down

0 comments on commit cf882a1

Please sign in to comment.