Release Workflow
Pre-steps
- Update
version
andappVersion
fields incharts/*/Chart.yaml
- Update version in
/VERSION
- Set a version tag on the correct branch. The version should follow the pattern:
- v0.1.0-rc0
- v0.1.0-rc1
- v0.1.0
- v0.1.1
- v0.1.2
- v0.2.0-rc0
- v0.2.0
Push a Version Tag
When a tag vx.x.x is pushed, the following steps will automatically run:
- Verify that the tag name matches the
/VERSION
- Create a branch named
release-vx.x.x
- Build the images with the pushed tag and push them to the ghcr registry
- Generate the changelog based on historical PRs labeled as
release/*
- Submit the changelog file to the
changelogs
directory of thegithub_pages
branch, with PR labeled aspr/release/robot_update_githubpage
- Changelogs are generated based on historical PR labels:
- Label
release/feature
will be classified as "Changed Features" - Label
release/bug
will be classified as "Fixes"
- Label
- Submit the changelog file to the
- Build the chart package with the pushed tag and submit a PR to the
github_pages
branch- Retrieve the chart with the command
helm repo add $REPO_NAME https://spidernet-io.github.io/$REPO_NAME
- Retrieve the chart with the command
- Submit
/docs
to the/docs
directory of thegithub_pages
branch - Create a GitHub Release with the chart package and changelog attached
- Manually approve the chart PR labeled as
pr/release/robot_update_githubpage
and the changelog PR labeled aspr/release/robot_update_githubpage