shaybentk/helm-docs-gh-actions
A Github action for generating helm documentation using helm-docs and gomplate.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| working-dir | Comma separated list of directories to generate docs for (ignored if `atlantis-file` or `find-dir` is set) | no | . |
| working-chart | Comma separated list of directories to generate docs for (ignored if `atlantis-file` or `find-dir` is set) | no | . |
| output-file | File in module directory where the docs should be placed | no | README.md |
| git-push | If true it will commit and push the changes | no | false |
| git-push-user-name | If empty the name of the GitHub Actions bot will be used (i.e. `github-actions[bot]`) | no | "" |
| 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 | "" |
| git-commit-message | Commit message | no | helm-docs: automated action |
| git-push-sign-off | If true it will sign-off commit | no | false |
| fail-on-diff | Fail the job if there is any diff found between the generated output and existing file (ignored if `git-push` is set) | no | false |
Outputs
| name | description |
|---|---|
| num_changed | Number of files changed |