Skip to content

Commit

Permalink
docs(contributing): Add section on how to release patch versions
Browse files Browse the repository at this point in the history
  • Loading branch information
gracedo committed Sep 7, 2023
1 parent be619f4 commit 27656cc
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,18 @@ A Kubernetes Charts maintainer will review the Chart submission, and start a val

Once the Chart has been merged, the release job will automatically run in the CI to package and release the Chart.

### Releasing patch versions of charts

In some instances, we must release patches to previously released/published helm charts.
For example, if there is a fix we must make to a chart that was released in a previous version of DKP, for which there is already a newer release of the chart on the `main` branch.

Follow this process to create release branches for the helm chart in question:
* Check out the SHA at which the chart was at the release in which you need to patch
* Create a new release branch from this branch, with the format `release/helm-chart-name-N.N.x` e.g. `release/kube-prometheus-stack-46.8.x`
* Push the branch (this will be a protected branch)
* Open a PR against this release branch with your fixes, ensuring that you bump the helm chart patch version
* Once the PR merges, the publish workflow is triggered (on pushes to `release/*` branches)

## Support Channels

Whether you are a user or contributor, official support channels include:
Expand Down

0 comments on commit 27656cc

Please sign in to comment.