Add Helm chart workflow that checks for updated documentation

Signed-off-by: Marco Franssen <[email protected]>
2022-12-15 10:17:51 +01:00
parent 0b6b855576
commit 5025bdaf37
3 changed files with 70 additions and 0 deletions
@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+SCRIPTPATH=$(dirname "$0")
+HELM_DOCS_VERSION="1.11.0"
+
+case "$(uname -s)" in
+    Linux*)
+      machine=Linux
+      shasum=sha256sum
+      exe=helm-docs
+      ;;
+    Darwin*)
+      machine=Darwin
+      shasum=shasum
+      exe=helm-docs
+      ;;
+    MINGW64*)
+      machine=Windows
+      shasum=sha256sum
+      exe=helm-docs.exe
+      ;;
+esac
+
+function install_helm_docs {
+    curl -LO https://github.com/norwoodj/helm-docs/releases/download/v"${HELM_DOCS_VERSION}"/helm-docs_"${HELM_DOCS_VERSION}"_${machine}_x86_64.tar.gz
+    curl -L --output /tmp/checksums_helm-docs.txt https://github.com/norwoodj/helm-docs/releases/download/v${HELM_DOCS_VERSION}/checksums.txt
+    grep helm-docs_${HELM_DOCS_VERSION}_${machine}_x86_64.tar.gz /tmp/checksums_helm-docs.txt | $shasum -c -
+    mkdir -p "$SCRIPTPATH/bin"
+    tar -xf helm-docs_"${HELM_DOCS_VERSION}"_${machine}_x86_64.tar.gz ${exe}
+    mv ${exe} "$SCRIPTPATH/bin/"
+    rm helm-docs_"${HELM_DOCS_VERSION}"_${machine}_x86_64.tar.gz
+}
+
+if [ ! -f "$SCRIPTPATH/bin/${exe}" ] ; then
+  install_helm_docs
+elif [[ ! "$("$SCRIPTPATH/bin/${exe}" --version)" =~ .*"$HELM_DOCS_VERSION".* ]] ; then
+  install_helm_docs
+else
+  echo "Using '$("$SCRIPTPATH/bin/${exe}" --version)'"
+fi
+
+# validate docs
+"$SCRIPTPATH/bin/${exe}"
+git diff --exit-code
@@ -0,0 +1,23 @@
+name: Helm Chart CI
+
+on:
+  pull_request:
+    paths:
+      - 'charts/**'
+      - '.github/workflows/helm-chart-ci.yml'
+      - '.github/scripts/*.sh'
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-docs:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+
+      - name: Verify Docs updated
+        run: .github/scripts/helm-docs.sh
@@ -0,0 +1 @@
+.github/scripts/bin