From 51501cce9d01ecee5c1a66591a5aed6f73254084 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Tue, 8 Mar 2022 16:10:53 +0100 Subject: [PATCH] chore: check helm docs are up to date (#3310) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché Co-authored-by: shuting --- .github/workflows/helm-check-docs.yaml | 20 ++++++++++++++++++++ Makefile | 8 ++++++++ 2 files changed, 28 insertions(+) create mode 100644 .github/workflows/helm-check-docs.yaml diff --git a/.github/workflows/helm-check-docs.yaml b/.github/workflows/helm-check-docs.yaml new file mode 100644 index 0000000000..fd0ace1519 --- /dev/null +++ b/.github/workflows/helm-check-docs.yaml @@ -0,0 +1,20 @@ +name: helm-check-docs + +on: + pull_request: + branches: + - main + - release* + paths: + - charts/** + - .github/workflows/helm-check-docs.yaml + +jobs: + check-helm-docs: + name: Check Helm docs + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Check docs are up to date + run: make check-helm-docs diff --git a/Makefile b/Makefile index e1fbec48e8..33fd9dd4e9 100644 --- a/Makefile +++ b/Makefile @@ -387,3 +387,11 @@ vet: .PHONY: gen-helm-docs gen-helm-docs: ## Generate Helm docs @docker run -v ${PWD}:/work -w /work jnorwood/helm-docs:v1.6.0 -s file + +.PHONY: check-helm-docs +check-helm-docs: gen-helm-docs ## Check Helm docs + git add --all + git diff charts/**/README.md + @echo 'If this test fails, it is because the git diff is non-empty after running "make gen-helm-docs".' + @echo 'To correct this, locally run "make gen-helm-docs", commit the changes, and re-run tests.' + git diff --quiet --exit-code charts/**/README.md