freerangebytes/Action Docs Generator
Generates comprehensive README documentation from action.yaml metadata files
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 10, 2026
- License
- MIT
Pinned Snippet
uses: freerangebytes/action-docs-generator@01217fee8c3c8680d75949c2afc40fda7b3d4e0b # v0.1.2tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| action-path | Path to the action.yaml or action.yml file to document | no | ./action.yaml |
| output-path | Path where the generated README should be written | no | ./README.md |
| description | Custom description to use instead of the one from action.yaml | no | "" |
| description-path | Path to a markdown file containing the description to use instead of the one from action.yaml | no | "" |
| template-path | Path to a custom Handlebars template file (optional) | no | "" |
| license | License type (e.g., MIT, Apache-2.0) or custom license text | no | MIT |
| badges | JSON array of badge configurations [{label, message, color, url}] or markdown badge strings | no | [] |
| include-sections | Comma-separated list of sections to include (all if empty). Available: title, badges, description, requirements, permissions, inputs, outputs, usage, examples, contributing, license | no | "" |
| exclude-sections | Comma-separated list of sections to exclude | no | "" |
| example | Custom usage example YAML to include in README | no | "" |
| examples-path | Path to a YAML file containing custom examples [{title, description, name?, version?, with?}] | no | "" |
| contributing-url | URL to CONTRIBUTING.md or contributing guidelines | no | "" |
| repository-url | Repository URL for generated links (auto-detected if in GitHub Actions) | no | "" |
| header-level | Starting header level for generated sections (1, 2, or 3) | no | 1 |
| version | Version tag to use in generated examples (e.g., v1, main, latest) | no | main |
Outputs
| name | description |
|---|---|
| readme-path | Absolute path to the generated README file |
| content | The generated README content as a string |
| sections-generated | JSON array of section names that were included in the output |