From d0ac1e3d943656c8c76ee000f7f78784bc06d9e4 Mon Sep 17 00:00:00 2001 From: Daniel Farrell Date: Thu, 24 Jun 2021 10:12:53 -0400 Subject: [PATCH] Add helm-docs generation and linting Autogenerate docs for each PR and verify they are up-to-date. Signed-off-by: Daniel Farrell --- .github/workflows/linting.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index 1637366e..c0220eb3 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -39,6 +39,28 @@ jobs: - name: Run gitlint run: make gitlint + helm-docs: + name: Helm Docs Generation + runs-on: ubuntu-latest + steps: + - name: Check out the repository + uses: actions/checkout@v2 + + - name: Run helm-docs + run: | + HELM_DOCS_VERSION="0.15.0" + # Avoid polluting repo with helm-docs' README/LICENSE or other files in the release archive + cd /tmp + curl -sL "https://github.com/norwoodj/helm-docs/releases/download/v${HELM_DOCS_VERSION}/helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz" | tar zx + cd - + /tmp/helm-docs + if [[ ! -z "$(git status --porcelain)" ]]; then + echo "Helm docs not up-to-date:" + git status --porcelain + echo "Run helm-docs, as the CI does above, and commit the updated docs." + exit 1 + fi + markdown-link-check: name: Markdown Links (modified files) runs-on: ubuntu-latest