GitHub Action
Helm Docs GitHub Action
Install helm-docs tool and auto-generate Markdown documentation from Helm charts. It always uses latest version of helm-docs.
To use this action, add the following step to your workflow:
name: Generate Helm documentation
on:
- pull_request
jobs:
generate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}
- name: Run helm-docs
uses: losisin/helm-docs-github-action@v1Note
This will only generate Markdown documentation but no further action will be taken.
| Name | Description | Default | Required |
|---|---|---|---|
chart-search-root |
The root directory to search recursively within for charts | . |
false |
values-file |
Path to values file | values.yaml |
false |
output-file |
Markdown file path relative to each chart directory to which rendered documentation will be written | README.md |
false |
git-push |
If true it will commit and push the changes (ignored if fail-on-diff is set) |
false |
false |
git-push-user-name |
If empty the name of the GitHub Actions bot will be used | github-actions[bot] |
false |
git-push-user-email |
If empty the no-reply email of the GitHub Actions bot will be used | github-actions[bot]@users.noreply.github.com |
false |
git-commit-message |
Commit message | update Helm documentation |
false |
fail-on-diff |
Fail the job if there is any diff found between the generated output and existing file | false |
false |
| Name | Description |
|---|---|
plugin-path |
Path to the cached helm-docs binary |
To fail the workflow if there is a diff between the generated documentation and the committed one, add the following step to your workflow:
name: Generate Helm documentation
on:
- pull_request
jobs:
generate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}
- name: Run helm-docs
uses: losisin/helm-docs-github-action@v1
with:
fail-on-diff: trueNote
This options are ignored if fail-on-diff: true.
To automatically commit the generated documentation, add the following step to your workflow:
name: Generate Helm documentation
on:
- pull_request
jobs:
generate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}
- name: Run helm-docs
uses: losisin/helm-docs-github-action@v1
with:
git-push: trueTo overwrite default user and email which is set to github-actions[bot] and add custom commit message, add the following:
name: Generate Helm documentation
on:
- pull_request
jobs:
generate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}
- name: Run helm-docs
uses: losisin/helm-docs-github-action@v1
with:
input: values.yaml
git-push: true
git-push-user-name: "John Doe"
git-push-user-email: "[email protected]"
git-commit-message: "chore: update Helm documentation"Your input matters. Feel free to open issues for bugs, feature requests, or any feedback you may have. Check if a similar issue exists before creating a new one, and please use clear titles and explanations to help understand your point better. Your thoughts help me improve this project!
🌟 Thank you for considering contributing to my project! Your efforts are incredibly valuable. To get started:
- Fork the repository.
- Create your feature branch:
git checkout -b feature/YourFeature - Commit your changes:
git commit -am 'Add: YourFeature' - Push to the branch:
git push origin feature/YourFeature - Submit a pull request! 🚀