Skip to content

Commit 3508094

Browse files
committed
feat(helm): generate docs can generate values json schema
Signed-off-by: Emilien Escalle <[email protected]>
1 parent a1042a1 commit 3508094

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

actions/helm/generate-docs/action.yml

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ inputs:
1414
description: "Working directory"
1515
required: false
1616
default: "${{ github.workspace }}"
17+
values-file:
18+
description: |
19+
Path to the values file to use for generating the documentation.
20+
If not provided, it will use the default values file.
21+
required: false
22+
default: "values.yaml"
1723
github-token:
1824
description: |
1925
GitHub Token to create and merge pull request.
@@ -47,16 +53,31 @@ runs:
4753
echo "working-directory=${{ inputs.working-directory }}" >> "$GITHUB_OUTPUT"
4854
echo "working-directory-name=$(basename "${{ inputs.working-directory }}")" >> "$GITHUB_OUTPUT"
4955
56+
values_file="${{ inputs.values-file }}"
57+
if [ ! -z "$values_file" ]; then
58+
if [ ! -f "${working_directory}/${values_file}" ]; then
59+
echo "The values file '${values_file}' does not exist in the working directory '${working_directory}'."
60+
exit 1
61+
fi
62+
values_file=$(realpath "${working_directory}/${values_file}")
63+
echo "values-file=${values_file}" >> "$GITHUB_OUTPUT"
64+
fi
65+
5066
- uses: hoverkraft-tech/ci-github-common/actions/checkout@6857ef6d10f704e0998aa4955282f27d1b9be778 # 0.23.1
5167

5268
- uses: losisin/helm-docs-github-action@178c1a8927bcd668d487395beda342ba270895b3 # v1.6.1
5369
with:
5470
chart-search-root: ${{ steps.prepare-variables.outputs.working-directory }}
5571

72+
- if: ${{ steps.prepare-variables.outputs.values-file }}
73+
uses: losisin/helm-values-schema-json-action@28b1b33dcd9bd10bb8157627566f3971313a8872 # v2.0.4
74+
with:
75+
input: ${{ steps.prepare-variables.outputs.values-file }}
76+
5677
- name: Prettify code
5778
uses: creyD/prettier_action@8c18391fdc98ed0d884c6345f03975edac71b8f0 # v4.6
5879
with:
59-
prettier_options: --write ${{ steps.prepare-variables.outputs.working-directory }}/**/*.md
80+
prettier_options: --write ${{ steps.prepare-variables.outputs.working-directory }}/**/*.md ${{ steps.prepare-variables.outputs.values-file }}
6081
no_commit: true
6182
working_directory: ${{ steps.prepare-variables.outputs.working-directory }}
6283

0 commit comments

Comments
 (0)