README.md

GitHub Action: Helm - Generate Chart Documentation

---

Overview

Action to generate documentation for a Helm chart. It will generate the documentation in the docs/ directory of the chart. Mainly using losisin/helm-docs-github-action.

Usage

- uses: hoverkraft-tech/ci-github-container/actions/helm/generate-docs@c9088e8447c5a8be45157e17701023fc50ccb1c0 # 0.37.2
  with:
    # Working directory
    # Default: `${{ github.workspace }}`
    working-directory: ${{ github.workspace }}

    # The Git ref to checkout before generating documentation.
    # Can be a branch, tag or commit SHA.
    # Set to an empty string to skip checkout.
    #
    # Default: `${{ github.ref }}`
    checkout-ref: ${{ github.ref }}

    # Path to the values file to use for generating the documentation.
    # See https://github.com/losisin/helm-values-schema-json-action.
    values-file: ""

    # GitHub Token to create and merge pull request.
    # Permissions:
    # - contents: write
    # - pull-requests: write
    #
    # Default: `${{ github.token }}`
    github-token: ${{ github.token }}

    # GitHub App client ID to generate GitHub token in place of github-token.
    # See https://github.com/actions/create-github-app-token.
    github-app-client-id: ""

    # GitHub App private key to generate GitHub token in place of github-token.
    # See https://github.com/actions/create-github-app-token.
    github-app-key: ""

Inputs

Input	Description	Required	Default
working-directory	Working directory	false	${{ github.workspace }}
checkout-ref	The Git ref to checkout before generating documentation.	false	${{ github.ref }}
	Can be a branch, tag or commit SHA.
	Set to an empty string to skip checkout.
values-file	Path to the values file to use for generating the documentation.	false	-
	See https://github.com/losisin/helm-values-schema-json-action.
github-token	GitHub Token to create and merge pull request.	false	${{ github.token }}
	Permissions:
	- contents: write
	- pull-requests: write
github-app-client-id	GitHub App client ID to generate GitHub token in place of github-token.	false	-
	See https://github.com/actions/create-github-app-token.
github-app-key	GitHub App private key to generate GitHub token in place of github-token.	false	-
	See https://github.com/actions/create-github-app-token.

Outputs

Output	Description
merged-sha	The SHA of the commit that was merged to the base branch. Will be empty if no pull request was created or merged.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.