npalm/Action to update GitHub Action documentation
Update docuemntation in the README file for a GitHub Action based on the action.yml.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| readme | Readme file to update. | no | README.md |
| actionFile | The action definition file. | no | — |
| sourceFile | The action or workflow definition file. | no | action.yml |
| includeNameHeader | Include the name header in the updated readme. | no | true |
| tocLevel | TOC level used for the headers. The `includeNameHeader` input is influecing the TOC level, setting `includeNameHeader` to true will increase the TOC level by 1. | no | 2 |
| lineBreaks | Line breaks to be used in updated readme (LF, CR or CRLF). | no | LF |
Outputs
no outputs