action-docs-action's Introduction

Action to update GitHub Action documentation

This action wraps action-docs to update action and workflow documentation. By default the action will update README.md based on the action.yml. See the parameters for changing the defaults.

Usage

header : to add/update a header based on the name of the action/workflow (only added if action option includeNameHeader is set to true)
description : to add/update a section with a descriptions of the action (applicable to actions only)
inputs: to add/update a section with inputs of the action/workflow
outputs: to add/update a section with outputs of the action/workflow
runs: to add/update a section of the environment required to run (applicable to actions only)
usage: to add/update a section containing an example of how to call the action/workflow. This comment also requires passing a project and a version to use in the example e.g. .
all: to include all of the above in order

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. Deprecated: This input is replaced by sourceFile	`false`	`""`
`sourceFile`	The action or workflow 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 or CRLF).	`false`	`LF`

Runs

This action is a node20 action.

License

This project are released under the MIT License.

action-docs-action's People

Contributors

Stargazers

Watchers

action-docs-action's Issues

Error: Cannot read properties of undefined (reading 'replace')

Hi!

I'm getting the following error when running this action from a workflow:
Error: Cannot read properties of undefined (reading 'replace')

I'm not getting any other specific details, so I'm not sure what the exact issue may by.

Here is an example of what is being passed to the action:

with:
    sourceFile: .github/actions/build/action.yml
    readme: .github/actions/build/README.md
    includeNameHeader: true
    tocLevel: 1
    lineBreaks: LF

The source and readme values are pointing to actions within the repository that are being fed in from tj-actions/changed-files. I am able to cat both of these files in a previous step and see their contents. Is this action expecting a different path?

Thanks for any guidance!

Extracted description broken

Extracted description of lineBreaks is broken, look here: https://github.com/npalm/action-docs-action/blob/develop/README.md#inputs

Action can't handle multi line descriptions.

When using multi line descriptions, the action will fail.

Example

See: https://github.com/philips-labs/slsa-provenance-action#inputs

Input

Output

Use conventional tagging for GitHub actions

It would be nice if this action followed the conventional tagging for GitHub actions.

See szenius/set-timezone#9 for a more detailed explanation.

Support multiple actions in single repo

I'm storing multiple actions in a single repo for simplicity.
I'd like to be able to run this action on multiple subdirectories.
Preferably by searching recursively for action.yaml/action.yaml file.