Skip to content

Commit

Permalink
Update README.md with Releasing documentation improvements (#299)
Browse files Browse the repository at this point in the history
  • Loading branch information
neuronull authored Apr 20, 2023
1 parent 2410475 commit 27d117a
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,24 @@ helm repo update
Charts are packaged and released with [`cr`](https://github.com/helm/chart-releaser)
when the `develop` branch is merged into `master`.

To make releasing easier two scripts have been included:

- `.github/release-vector-version.sh` queries [vectordotdev/vector](https://github.com/vectordotdev/vector)
for the latest release and updates the `vector` chart's default image. This is
convenient when updating the chart after a Vector release.
- `.github/release-changelog.sh` pulls the current `vector` chart version and
uses `git-cliff` to update the [CHANGELOG.md](CHANGELOG.md). Run this to generate
the final commit merged into `develop` before merging `develop` into `master`.
This script requires [`yq`](https://github.com/mikefarah/yq) and
To make releasing easier two scripts are utilized in the steps below.

1. `$ .github/release-vector-version.sh`
- This queries [vectordotdev/vector](https://github.com/vectordotdev/vector)
for the latest release and updates the `vector` chart's default image.
- This is convenient when updating the chart after a Vector release.

2. Commit the changes generated from step 1. This needs to be a
[conventional commit](https://www.conventionalcommits.org/).
- E.g. "feat(vector): Bump Vector to v0.29.0"

3. `$ .github/release-changelog.sh`
- This pulls the current `vector` chart version and uses `git-cliff` to update
the [CHANGELOG.md](CHANGELOG.md). Run this to generate the final commit merged into
`develop` before merging `develop` into `master`.
- This script requires [`yq`](https://github.com/mikefarah/yq) and
[`git-cliff`](https://github.com/orhun/git-cliff) to be installed.

4. Commit the changes generated from step 1. This needs to be a
[conventional commit](https://www.conventionalcommits.org/).
- E.g. "feat(vector): Regenerate CHANGELOG"

0 comments on commit 27d117a

Please sign in to comment.