docs: auto generate helm chart docs using helm-docs

Signed-off-by: Zuhair AlSader <zuhair@koor.tech>
2022-12-02 17:08:50 -05:00
parent fe1ef6c222
commit 792a261ca9
13 changed files with 732 additions and 312 deletions
@@ -33,6 +33,15 @@ jobs:
        with:
          python-version: 3.9

+      - name: Run helm-docs
+        run: |
+          make helm-docs
+          DIFF=$(git diff)
+          if [ ! -z "$DIFF" ]; then
+            echo "Please run 'make helm-docs' locally, commit the updated docs, and push the change. See https://rook.io/docs/rook/latest/Contributing/documentation/#running-helm-docs"
+          fi
+          git diff --exit-code
+
      - name: Install mkdocs and dependencies
        run: cd build/release/ && make deps.docs