This action wraps action-docs to update action documentation. By default the action will update README.md based on the the action.yml. See the parameters for changing the defaults.
The action will update you readme by replacing html comment tags. Add one of more tags based on the following template to your repo: <!-- action-docs-(description | inputs | outputs | runs --> to add the corresponding section.
description: to add/update a section with a descriptions of the actioninputs: to add/update a section with inputs of the actionoutpus: to add/update a section with outputs of the actionruns: : to add/update a section of the environment required to run.
In your workflow add the action, see below for the available parameters.
- uses: npalm/action-docs-actionThe action will not commit any change, to ensure the changes are persisted you can use an action to commit or raise a pull request.
| parameter | description | required | default |
|---|---|---|---|
| readme | Readme file to update. | false |
README.md |
| actionFile | THe action definition file. | false |
action.yml |
| tocLevel | TOC level used for the headers. | false |
2 |
| lineBreaks | Line breaks to be used in updated readme (LF | CR | CRLF). |
This action is a node16 action.
This project are released under the MIT License.