docs: add release chart docs

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
kyverno · Nov 6, 2024 · 7fc5e31 · 7fc5e31
1 parent c4a809e
commit 7fc5e31
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/.github/workflows/helm-release.yaml b/.github/workflows/helm-release.yaml
@@ -7,10 +7,10 @@ permissions: {}
 on:
   push:
     tags:
-      - 'chart-v*'
+      - 'charts-v*'
 
 jobs:
-  chart-releaser:
+  charts-releaser:
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -24,8 +24,8 @@ jobs:
         run: |
           set -e
           TAG=${{ github.ref_name }}
-          echo "CHART_VERSION=${TAG#chart-}" >> $GITHUB_ENV
-      - name: Run chart-releaser
+          echo "CHART_VERSION=${TAG#charts-}" >> $GITHUB_ENV
+      - name: Run charts releaser
         uses: stefanprodan/helm-gh-pages@0ad2bb377311d61ac04ad9eb6f252fb68e207260 #v1.7.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/docs/RELEASE.md b/docs/RELEASE.md
@@ -16,6 +16,20 @@ git tag $TAG -m "tag $TAG" -a
 git push origin $TAG
 ```
 
+## Publish chart
+
+Publishing the chart for a release is decoupled from cutting a release.
+
+To publish the chart push a tag to the GitHub repository (beginning with `charts-v`).
+
+```shell
+VERSION="v0.0.1"
+TAG=charts-$VERSION
+
+git tag $TAG -m "tag $TAG" -a
+git push origin $TAG
+```
+
 ## Publish documentation
 
 Publishing the documentation for a release is decoupled from cutting a release.