losisin/Helm Docs GitHub Action
A GitHub action for generating markdown documentation using helm-docs
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| chart-search-root | The root directory to search recursively within for charts | no | . |
| values-file | Path to values file | no | values.yaml |
| output-file | Markdown file path relative to each chart directory to which rendered documentation will be written | no | README.md |
| template-files | Comma separated list of template files to render | no | README.md.gotmpl |
| sort-values-order | Order in which to sort the values table | no | "" |
| skip-version-footer | If true the helm-docs version footer will not be shown in the default README template | no | false |
| git-push | If true it will commit and push the changes (ignored if `fail-on-diff` is set) | no | false |
| git-push-user-name | If empty the name of the GitHub Actions bot will be used (i.e. `github-actions[bot]`) | no | github-actions[bot] |
| git-push-user-email | If empty the no-reply email of the GitHub Actions bot will be used (i.e. `github-actions[bot]@users.noreply.github.com`) | no | github-actions[bot]@users.noreply.github.com |
| git-commit-message | Commit message | no | update Helm documentation |
| fail-on-diff | Fail the job if there is any diff found between the generated output and existing file | no | false |
| version | The version of helm-docs to install and use | no | v1.14.2 |
Outputs
| name | description |
|---|---|
| helm-docs-path | Path to the cached helm-docs binary |