chore: check helm docs are up to date (#3310)

Signed-off-by: Charles-Edouard Brétéché <charled.breteche@gmail.com>

Co-authored-by: shuting <shuting@nirmata.com>

.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

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