diff --git a/.github/workflows/helm-docs.yaml b/.github/workflows/helm-docs.yaml new file mode 100644 index 0000000..1e1534b --- /dev/null +++ b/.github/workflows/helm-docs.yaml @@ -0,0 +1,41 @@ +name: helm-docs + +on: + pull_request: + branches: + - main + +permissions: + contents: read + +jobs: + helm-docs: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 + with: + persist-credentials: false + + - name: Install helm-docs + run: | + HELM_DOCS_VERSION=$(curl -sSL https://api.github.com/repos/norwoodj/helm-docs/releases/latest | grep '"tag_name"' | sed 's/.*"v\([^"]*\)".*/\1/') + echo "Installing helm-docs v${HELM_DOCS_VERSION}" + curl -sSL "https://github.com/norwoodj/helm-docs/releases/download/v${HELM_DOCS_VERSION}/helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz" \ + | tar -xz helm-docs + sudo mv helm-docs /usr/local/bin/helm-docs + helm-docs --version + + - name: Run helm-docs + run: helm-docs + + - name: Check README is up to date + run: | + if ! git diff --quiet README.md; then + echo "README.md is out of date. Run helm-docs locally and commit the updated file." + echo "" + git diff README.md + exit 1 + fi + echo "README.md is up to date."