aisrael/actiondoc

Generates documentation from your GitHub Action's `action.yml`

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stalelast commit Jan 3, 2024
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: aisrael/actiondoc@87af445261bcb996a7a314fa2853730d8eef05af # 0.2.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
template-filenameThe path to the ERB template to use to generate the documentation.no
output-filenameThe filename to save the output to. If not specified, simply prints to standard output.no
path-to-action-ymlThe path to the `action.yml` file to generate documentation for. If not specified, assumes `action.yml`.no
working-directoryThe directory to perform the action in, if not $GITHUB_WORKSPACEno

no outputs