Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabe565/setup-helm-docs-action
Action that installs Helm Docs, a tool for automatically generating markdown documentation for Helm charts
https://github.com/gabe565/setup-helm-docs-action
github-actions helm helm-docs kubernetes
Last synced: 3 months ago
JSON representation
Action that installs Helm Docs, a tool for automatically generating markdown documentation for Helm charts
- Host: GitHub
- URL: https://github.com/gabe565/setup-helm-docs-action
- Owner: gabe565
- Created: 2023-04-14T05:44:16.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-28T04:56:50.000Z (7 months ago)
- Last Synced: 2024-10-14T09:12:50.135Z (4 months ago)
- Topics: github-actions, helm, helm-docs, kubernetes
- Homepage:
- Size: 20.5 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Setup Helm Docs Action
This action installs [norwoodj/helm-docs](https://github.com/norwoodj/helm-docs), a tool for automatically generating markdown documentation for Helm charts.
## Usage
### Inputs
| Name | Description | Required | Default |
|-----------|----------------------------------|----------|---------------------------------------------------------------|
| `version` | The Helm Docs version to install | `false` | `latest` |
| `repo` | The Helm Docs repo to use | `false` | [`norwoodj/helm-docs`](https://github.com/norwoodj/helm-docs) |
| `token` | GitHub token | `false` | `${{ github.token }}` |
### Outputs
| Name | Description |
|-----------|------------------------------------------|
| `version` | The Helm Docs version that was installed |
## Example Workflow
```yaml
name: Update Chart Metadata
on: push
jobs:
update-chart-metadata:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: gabe565/setup-helm-docs-action@v1
- run: helm-docs
```