Skip to content

Commit f1d0fec

Browse files
committed
feat(helm): Improve docs, add schema
1 parent 95f50fb commit f1d0fec

File tree

4 files changed

+1670
-7
lines changed

4 files changed

+1670
-7
lines changed

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

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010

1111
jobs:
1212
lint:
13-
name: Lint chart
13+
name: Lint chart (version)
1414
runs-on: ubuntu-latest
1515
steps:
1616
- name: Checkout
@@ -73,3 +73,47 @@ jobs:
7373
# - name: Run chart-testing (install)
7474
# 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'
7575
# if: env.changed == 'true'
76+
77+
docs generation:
78+
name: Update documentation
79+
runs-on: ubuntu-latest
80+
steps:
81+
- name: Checkout
82+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
83+
84+
- name: Run helm-docs
85+
uses: losisin/helm-docs-github-action@a57fae5676e4c55a228ea654a1bcaec8dd3cf5b5 # v1.6.2
86+
with:
87+
fail-on-diff: true
88+
chart-search-root: "helm/defectdojo"
89+
90+
generate schema:
91+
name: Update schema
92+
runs-on: ubuntu-latest
93+
steps:
94+
- name: Checkout
95+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
96+
97+
- name: Generate values schema json
98+
uses: losisin/helm-values-schema-json-action@28b1b33dcd9bd10bb8157627566f3971313a8872 # v2.0.4
99+
with:
100+
fail-on-diff: true
101+
working-directory: "helm/defectdojo"
102+
useHelmDocs: true
103+
104+
lint format:
105+
name: Lint chart (format)
106+
runs-on: ubuntu-latest
107+
steps:
108+
- name: Checkout
109+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
110+
with:
111+
persist-credentials: false
112+
fetch-depth: 0
113+
114+
- name: Set up Helm
115+
uses: azure/setup-helm@b9e51907a09c216f16ebe8536097933489208112 # v4.3.0
116+
117+
- name: Lint
118+
run: |-
119+
helm lint ./helm/defectdojo --strict

0 commit comments

Comments
 (0)