add helm docs script

magda-io · Aug 13, 2023 · 7622022 · 7622022
1 parent a383e1e
commit 7622022
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -31,7 +31,7 @@ jobs:
       - name: Check Helm Chart Document
         run: |
           code=0
-          docker run --rm -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.5.0 -t ./README.md.gotmpl -o ../../README.md || code=$?;
+          yarn helm-docs || code=$?;
           if [ "$code" != "0" ]; then 
             echo "Failed to run helm-docs!";
             exit 1;
@@ -41,7 +41,7 @@ jobs:
           git ls-files -m | grep -i readme.md || code=$?;
           if [ "$code" == "0" ]; then
             echo -e "Some of helm chart docs are required to be updated using the [helm-docs](https://github.com/norwoodj/helm-docs) tool. \n
-            Please run helm-docs (v1.5.0) at project root, review & commit docs changes and push a new commit.";
+            Please run helm-docs (v1.11.0) at project root, review & commit docs changes and push a new commit.";
             exit 1;
           else 
             echo -e "helm docs check passed. helm docs update is not required.";

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -34,7 +34,7 @@ jobs:
       - name: Check Helm Chart Document
         run: |
           code=0
-          docker run --rm -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.5.0 -t ./README.md.gotmpl -o ../../README.md || code=$?;
+          yarn helm-docs || code=$?;
           if [ "$code" != "0" ]; then 
             echo "Failed to run helm-docs!";
             exit 1;
@@ -44,7 +44,7 @@ jobs:
           git ls-files -m | grep -i readme.md || code=$?;
           if [ "$code" == "0" ]; then
             echo -e "Some of helm chart docs are required to be updated using the [helm-docs](https://github.com/norwoodj/helm-docs) tool. \n
-            Please run helm-docs (v1.5.0) at project root, review & commit docs changes and push a new commit.";
+            Please run helm-docs (v1.11.0) at project root, review & commit docs changes and push a new commit.";
             exit 1;
           else 
             echo -e "helm docs check passed. helm docs update is not required.";

diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
     "docker-build-prod": "create-docker-context-for-node-component --build --push --tag auto",
     "test": "mocha",
     "helm-lint": "helm lint deploy/magda-minion-format -f deploy/test-deploy.yaml",
-    "helm-docs": "helm-docs -t ./README.md.gotmpl -o ../../README.md",
+    "helm-docs": "docker run --rm -v \"$(pwd):/helm-docs\" -u $(id -u) jnorwood/helm-docs:v1.11.0 -t ./README.md.gotmpl -o ../../README.md",
     "update-all-charts": "helm dep up ./deploy/magda-minion-format",
     "add-all-chart-version-changes": "git ls-files -m | grep Chart.yaml | xargs git add && git ls-files -m | grep Chart.lock | xargs git add",
     "add-all-helm-docs-changes": "yarn helm-docs && git ls-files -m | grep -i readme.md | xargs git add",