Changelogs on ccv-cell releases

.github/workflows/helm-ccv-cell-release.yml

@@ -52,4 +52,10 @@ jobs:
       - name: Create GitHub release
         env:
           GH_TOKEN: ${{ github.token }}
-        run: gh release create "$GITHUB_REF_NAME" --title "ccv-cell $GITHUB_REF_NAME" --generate-notes
+        run: |
+          notes_file="${CHART}/changelogs/${GITHUB_REF_NAME}.md"
+          if [ -f "$notes_file" ]; then
+            gh release create "$GITHUB_REF_NAME" --title "ccv-cell $GITHUB_REF_NAME" --notes-file "$notes_file" --generate-notes
+          else
+            gh release create "$GITHUB_REF_NAME" --title "ccv-cell $GITHUB_REF_NAME" --generate-notes
+          fi

README.md

@@ -34,6 +34,9 @@ and fail CI!
 The [`ccv-cell` helm chart](./charts/ccv-cell) is released on tag pushes that follow the `v*` pattern. The version in
 `Chart.yaml` is overridden by CI using the git tag provided.
 
+Custom release notes can be provided by writing up a `charts/ccv-cell/changelogs/<version>.md` file before setting the
+tag.
+
 To trigger a release, simply push release tags like so:
 ```shell
 newVersion=v9.8.7  # the version being released

RUNBOOK.md

@@ -770,4 +770,3 @@ If you're building SLOs on top of these metrics, three starting points:
   at zero.
 
 Actual SLO targets are your own business decision, not something this guide can set for you.
-

charts/ccv-cell/.helmignore

@@ -1 +1,2 @@
 README.md.gotmpl
+changelogs/

charts/ccv-cell/changelogs/v0.6.1.md

@@ -0,0 +1,5 @@
+# First Beta Release
+
+This marks the first beta release of the ccv-cell Helm Chart.
+
+No significant changes are expected to the chart at this time, but some breaking changes might still occur.