Skip to content

RELEASING.md

Latest commit

 

History

History
61 lines (48 loc) · 2.52 KB

RELEASING.md

File metadata and controls

61 lines (48 loc) · 2.52 KB

Releasing

This document is intended for project maintainers.

Charts are packaged and released with cr when the develop branch is merged into master.

Install the following required tools:

Now run the release script:

bash release.sh <Vector release GitHub issue link>

This will create the pull requests and wait for them to be approved and merged. If the script fails, please refer to the following section and continue the release manually.

After the script runs, the release workflow should start automatically. Once it completes, you will have successfully released helm-charts!

Releasing manually

Always prefer the automated method described above. Use this guide only if the above method fails. To make releasing easier two scripts are utilized in the steps below.

  1. Run $ .github/release-vector-version.sh

    • Update Helm docs by running helm-docs
    • Commit the changes generated from step 1. This needs to be a conventional commit.
      • E.g. "feat(vector): Bump Vector to v0.29.0"
      • Submit a PR with the changes.
    • Notes:
      • This queries 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.
      • On macOS, install gsed

  2. Run $ .github/release-changelog.sh

    • Commit the changes generated from step 1. This needs to be a conventional commit.
      • E.g. "feat(vector): Regenerate CHANGELOG"
    • Submit a PR with the changes.
    • Notes:
      • This pulls the current vector chart version and uses git-cliff to update the CHANGELOG.md. Run this to generate the final commit merged into develop before merging develop into master.
      • This script requires yq and git-cliff to be installed.

  3. To kick off the release workflow:

  git switch master
  git pull
  git merge develop
  git push