From b677f667b3a8ab92e8c332e02eaad461234df6bf Mon Sep 17 00:00:00 2001 From: kiblik <5609770+kiblik@users.noreply.github.com> Date: Tue, 16 Sep 2025 21:25:20 +0200 Subject: [PATCH] feat(helm): Better explanation for failing GHA --- .github/workflows/test-helm-chart.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test-helm-chart.yml b/.github/workflows/test-helm-chart.yml index dd2d5daed48..1eb1b68904b 100644 --- a/.github/workflows/test-helm-chart.yml +++ b/.github/workflows/test-helm-chart.yml @@ -80,7 +80,9 @@ jobs: - name: Checkout uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - # If this step is failing, run `helm-docs --chart-search-root helm/defectdojo` + # Documentation provided in the README file needs to contain the latest information from `values.yaml` and all other related assets. + # If this step fails, install https://github.com/norwoodj/helm-docs and run locally `helm-docs --chart-search-root helm/defectdojo` before committing your changes. + # The helm-docs documentation will be generated for you. - name: Run helm-docs uses: losisin/helm-docs-github-action@a57fae5676e4c55a228ea654a1bcaec8dd3cf5b5 # v1.6.2 with: @@ -94,7 +96,10 @@ jobs: - name: Checkout uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - # If this step is failing, run `helm schema --use-helm-docs` in `helm/defectdojo` + # The HELM structure supports the existence of a `values.schema.json` file. This file is used to validate all values provided by the user before Helm starts rendering templates. + # The chart needs to have a `values.schema.json` file that is compatible with the default `values.yaml` file. + # If this step fails, install https://github.com/losisin/helm-values-schema-json and run locally `helm schema --use-helm-docs` in `helm/defectdojo` before committing your changes. + # The helm schema will be generated for you. - name: Generate values schema json uses: losisin/helm-values-schema-json-action@28b1b33dcd9bd10bb8157627566f3971313a8872 # v2.0.4 with: