pndurette/GitHub Actions Auto-Docs
A GitHub Action for generating GitHub Actions documentation
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| action_yaml_file | The path to the GitHub Action's `action.yml` file | no | ./action.yml |
| include_inputs | Whenever to document the action's inputs | no | true |
| include_outputs | Whenever to document the action's outputs | no | true |
| heading_size | The Markdown heading size to use for the documented sections (i.e. number of `#`) | no | 3 |
| template_file | The file used as template | no | ./README.md |
| target_file | The resulting file of the template substitution. To update in-place, this can be the same as `template_file`. | no | ./README.md |
| marker_start | The opening marker from which the template substitution will take place | no | <!--doc_begin--> |
| marker_end | The closing marker to which the template substitution will take place | no | <!--doc_end--> |
| git_push | Whenever to commit and push changes changes to `target_file` | no | true |
| git_push_user_name | The git user name to commit with | no | github-actions[bot] |
| git_push_user_email | The git user email to commit with | no | github-actions[bot]@users.noreply.github.com |
| git_commit_message | The git commit message | no | GitHub Action Auto-Docs |
| git_commit_signoff | Whenever to sign-off the git commit | no | false |
Outputs
no outputs