Feat: add helm doc check to PR verification (#503)

* Add helm doc check to PR verification Signed-off-by: Brendan Cronin <[email protected]> * Check for changes Signed-off-by: Brendan Cronin <[email protected]> * Resolve README.md conflicts Signed-off-by: Brendan Cronin <[email protected]> * Correct file change behavior Signed-off-by: Brendan Cronin <[email protected]> * Checking Signed-off-by: Brendan Cronin <[email protected]> * Checking Signed-off-by: Brendan Cronin <[email protected]> * Checking Signed-off-by: Brendan Cronin <[email protected]> * Checking Signed-off-by: Brendan Cronin <[email protected]> * Checking Signed-off-by: Brendan Cronin <[email protected]> * Checking Signed-off-by: Brendan Cronin <[email protected]> * Positive check Signed-off-by: Brendan Cronin <[email protected]> * Add verbosity Signed-off-by: Brendan Cronin <[email protected]> * Positive check Signed-off-by: Brendan Cronin <[email protected]> * Update .github/workflows/verify.yaml Co-authored-by: Paul Latzelsperger <[email protected]> * Changes from review Signed-off-by: Brendan Cronin <[email protected]> --------- Signed-off-by: Brendan Cronin <[email protected]> Co-authored-by: Paul Latzelsperger <[email protected]>
eclipse-tractusx · Jun 23, 2023 · 3794f44 · 3794f44
1 parent 392060d
commit 3794f44
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -58,6 +58,26 @@ jobs:
             eval $cmd;
             exit 1;
           fi
+
+  verify-helm-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: addnab/docker-run-action@v3
+        with:
+          image: jnorwood/helm-docs:v1.10.0
+          options: -v ${{ github.workspace }}/charts:/helm-docs
+          run: helm-docs
+
+      - run: |
+          if $(git diff --quiet --exit-code); then
+            echo "Helm chart docs up to date"
+          else
+            echo "Helm chart docs not up to date:"
+            git diff
+            exit 1
+          fi
   
   verify-formatting:
     runs-on: ubuntu-latest