npalm / action-docs-action

Action to update GitHub action documentation

Action to update GitHub Action documentation

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.

Usages

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-(header | description | inputs | outputs | runs --> to add the corresponding section.

• header : to add/updae a header based on the name of the action
• description : to add/update a section with a descriptions of the action
• inputs: to add/update a section with inputs of the action
• outputs: to add/update a section with outputs of the action
• runs: 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-action

The action will not commit any change, to ensure the changes are persisted you can use an action to commit or raise a pull request.

Inputs

name	description	required	default
readme	Readme file to update.	false	README.md
actionFile	THe action definition file.	false	action.yml
includeNameHeader	Include the name header in the updated readme.	false	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.	false	2
lineBreaks	Line breaks to be used in updated readme (LF	CR	CRLF).

Runs

This action is a node20 action.

License

This project are released under the MIT License.