Skip to content

Commit 9159e3d

Browse files
authored
feat(helm): Better explanation for failing GHA (#13198)
1 parent 25a32cc commit 9159e3d

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ jobs:
8080
- name: Checkout
8181
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
8282

83-
# If this step is failing, run `helm-docs --chart-search-root helm/defectdojo`
83+
# Documentation provided in the README file needs to contain the latest information from `values.yaml` and all other related assets.
84+
# 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.
85+
# The helm-docs documentation will be generated for you.
8486
- name: Run helm-docs
8587
uses: losisin/helm-docs-github-action@a57fae5676e4c55a228ea654a1bcaec8dd3cf5b5 # v1.6.2
8688
with:
@@ -94,7 +96,10 @@ jobs:
9496
- name: Checkout
9597
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
9698

97-
# If this step is failing, run `helm schema --use-helm-docs` in `helm/defectdojo`
99+
# 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.
100+
# The chart needs to have a `values.schema.json` file that is compatible with the default `values.yaml` file.
101+
# 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.
102+
# The helm schema will be generated for you.
98103
- name: Generate values schema json
99104
uses: losisin/helm-values-schema-json-action@d5847286fa04322702c4f8d45031974798c83ac7 # v2.3.0
100105
with:

0 commit comments

Comments
 (0)