build(helm): generate README.md.gotmpl in CI

enix · Aug 13, 2024 · 4b763c6 · 4b763c6
1 parent b41f866
commit 4b763c6
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 363 deletions.
diff --git a/.github/workflows/pr-packaging.yml b/.github/workflows/pr-packaging.yml
@@ -32,7 +32,7 @@ jobs:
         run: |
           set -euo pipefail
           ct lint --chart-dirs deploy/charts --target-branch ${{ github.base_ref }} \
-            --validate-maintainers=false --check-version-increment=false 
+            --validate-maintainers=false --check-version-increment=false
 
       # FIXME
       #- name: Create KinD cluster

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -814,6 +814,7 @@ jobs:
 
           header('generate chart readme')
 
+          run('make', '-C', '../../', 'helm-docs')
           run(os.environ['HELM_DOCS_PATH'], '--dry-run')
           run(os.environ['HELM_DOCS_PATH'])
 

diff --git a/.gitignore b/.gitignore
@@ -28,3 +28,6 @@ zz_generated.*
 
 # helm dependencies
 helm/**/charts/*.tgz
+
+# generated helm README template
+helm/**/README.md.gotmpl