Skip to content

Commit 346cc66

Browse files
committed
feat(helm): Improve docs, add schema
1 parent cbdf895 commit 346cc66

4 files changed

Lines changed: 1677 additions & 7 deletions

File tree

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

Lines changed: 52 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
@@ -72,3 +72,54 @@ jobs:
7272
# - name: Run chart-testing (install)
7373
# 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'
7474
# if: env.changed == 'true'
75+
76+
docs_generation:
77+
name: Update documentation
78+
runs-on: ubuntu-latest
79+
steps:
80+
- name: Checkout
81+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
82+
83+
- name: Run helm-docs
84+
uses: losisin/helm-docs-github-action@a57fae5676e4c55a228ea654a1bcaec8dd3cf5b5 # v1.6.2
85+
with:
86+
fail-on-diff: true
87+
chart-search-root: "helm/defectdojo"
88+
89+
generate_schema:
90+
name: Update schema
91+
runs-on: ubuntu-latest
92+
steps:
93+
- name: Checkout
94+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
95+
96+
- name: Generate values schema json
97+
uses: losisin/helm-values-schema-json-action@28b1b33dcd9bd10bb8157627566f3971313a8872 # v2.0.4
98+
with:
99+
fail-on-diff: true
100+
working-directory: "helm/defectdojo"
101+
useHelmDocs: true
102+
values: values.yaml
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: Configure Helm repos
118+
run: |-
119+
helm repo add bitnami https://charts.bitnami.com/bitnami
120+
helm dependency list ./helm/defectdojo
121+
helm dependency update ./helm/defectdojo
122+
123+
- name: Lint
124+
run: |-
125+
helm lint ./helm/defectdojo --strict

0 commit comments

Comments
 (0)