feat(helm): Improve docs, add schema (#12984)

* feat(helm): Improve docs, add schema

* Swap helm/defectdojo/README.md & readme-docs/KUBERNETES.md

Author: kiblik

.github/workflows/test-helm-chart.yml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   lint:
-    name: Lint chart
+    name: Lint chart (version)
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -72,3 +72,55 @@ jobs:
       # - name: Run chart-testing (install)
       #   run: ct install --config ct.yaml --target-branch ${{ env.ct-branch }} --helm-extra-args '--set createSecret=true --set createRabbitMqSecret=true --set createPostgresqlSecret=true --set timeout=900'
       #  if: env.changed == 'true'
+
+  docs_generation:
+    name: Update documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      
+      # If this step is failing, run `helm-docs --chart-search-root helm/defectdojo`
+      - name: Run helm-docs
+        uses: losisin/helm-docs-github-action@a57fae5676e4c55a228ea654a1bcaec8dd3cf5b5 # v1.6.2
+        with:
+          fail-on-diff: true
+          chart-search-root: "helm/defectdojo"
+
+  generate_schema:
+    name: Update schema
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # If this step is failing, run `helm schema --use-helm-docs` in `helm/defectdojo`
+      - name: Generate values schema json
+        uses: losisin/helm-values-schema-json-action@28b1b33dcd9bd10bb8157627566f3971313a8872 # v2.0.4
+        with:
+          fail-on-diff: true
+          working-directory: "helm/defectdojo"
+          useHelmDocs: true
+          values: values.yaml
+
+  lint_format:
+    name: Lint chart (format)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@b9e51907a09c216f16ebe8536097933489208112 # v4.3.0
+
+      - name: Configure Helm repos
+        run: |-
+             helm dependency list ./helm/defectdojo
+             helm dependency update ./helm/defectdojo
+
+      - name: Lint
+        run: |-
+          helm lint ./helm/defectdojo --strict

helm/defectdojo/.helmignore

@@ -20,4 +20,4 @@
 .idea/
 *.tmproj
 .vscode/
-README.md
+README.md.gotmpl