Skip to content

feat(helm): generate docs can generate values json schema #467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
neilime merged 1 commit into from
Jul 15, 2025
Merged

feat(helm): generate docs can generate values json schema #467

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion actions/helm/generate-docs/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ inputs:
description: "Working directory"
required: false
default: "${{ github.workspace }}"
values-file:
description: |
Path to the values file to use for generating the documentation.
If not provided, it will use the default values file.
required: false
default: "values.yaml"
github-token:
description: |
GitHub Token to create and merge pull request.
Expand Down Expand Up @@ -47,16 +53,31 @@ runs:
echo "working-directory=${{ inputs.working-directory }}" >> "$GITHUB_OUTPUT"
echo "working-directory-name=$(basename "${{ inputs.working-directory }}")" >> "$GITHUB_OUTPUT"

values_file="${{ inputs.values-file }}"
if [ ! -z "$values_file" ]; then
if [ ! -f "${working_directory}/${values_file}" ]; then
echo "The values file '${values_file}' does not exist in the working directory '${working_directory}'."
exit 1
fi
values_file=$(realpath "${working_directory}/${values_file}")
echo "values-file=${values_file}" >> "$GITHUB_OUTPUT"
fi

- uses: hoverkraft-tech/ci-github-common/actions/checkout@6857ef6d10f704e0998aa4955282f27d1b9be778 # 0.23.1

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

- if: ${{ steps.prepare-variables.outputs.values-file }}
uses: losisin/helm-values-schema-json-action@28b1b33dcd9bd10bb8157627566f3971313a8872 # v2.0.4
with:
input: ${{ steps.prepare-variables.outputs.values-file }}

- name: Prettify code
uses: creyD/prettier_action@8c18391fdc98ed0d884c6345f03975edac71b8f0 # v4.6
with:
prettier_options: --write ${{ steps.prepare-variables.outputs.working-directory }}/**/*.md
prettier_options: --write ${{ steps.prepare-variables.outputs.working-directory }}/**/*.md ${{ steps.prepare-variables.outputs.values-file }}
no_commit: true
working_directory: ${{ steps.prepare-variables.outputs.working-directory }}

Expand Down
Loading