chore: Replace helm-docs script with GitHub Action (#263)

chore: Replace helm-docs script with GitHub Action, document helmdocsignore file
vectordotdev · Oct 30, 2022 · 9afc344 · 9afc344
1 parent 19af990
commit 9afc344
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 15 deletions.
diff --git a/.github/helm-docs.sh b/.github/helm-docs.sh
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -54,8 +54,14 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
+      - name: Install Helm Docs
+        uses: envoy/[email protected]
+        with:
+          version: 1.11.0
       - name: Run helm-docs
-        run: .github/helm-docs.sh
+        run: |
+          helm-docs
+          git diff --exit-code
 
   kubeval-chart:
     runs-on: ubuntu-latest

diff --git a/.helmdocsignore b/.helmdocsignore
@@ -1,3 +1,4 @@
+# Ignore deprecated charts
 charts/vector-agent
 charts/vector-aggregator
 charts/vector-shared