3lvia/gh-actions-docs

Automatically generate pretty documentation for your GitHub Actions!

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit May 5, 2026
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: 3lvia/gh-actions-docs@2db29362f0d6d92052f6fa49b71743af5f0c11f8 # v1.2.5

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

Inputs

name	description	required	default
readme-file	The file to read the action tags from and write the documentation to.	no	README.md
debug	Set to `true` to enable debug output.	no	false
ignore-files	Comma-separated list of `actions.yml`-files to ignore when generating action documentation.	no	—
ignore-headers	Comma-separated list of headers to ignore when generating a table of contents. Should include the `#`-prefixes, e.g. `## My Header` or `### My Other Header`.	no	—
run-prettier	Set to `true` to run Prettier on the generated documentation.	no	false
no-actions	Set to `true` to disable generation of any actions documentation. Useful when you only want to generate a table of contents. This cannot be set to `true` if `no-toc` is also set to `true`.	no	false
no-toc	Set to `true` to disable generation of a table of contents. Useful when you only want to generate actions documentation. This cannot be set to `true` if `no-actions` is also set to `true`.	no	false
no-name	Set to `true` to disable generation of action names.	no	false
no-description	Set to `true` to disable generation of action descriptions.	no	false
no-inputs	Set to `true` to disable generation of action inputs.	no	false
no-outputs	Set to `true` to disable generation of action outputs.	no	false
no-permissions	Set to `true` to disable generation of action permissions.	no	false
no-usage	Set to `true` to disable generation of usage examples.	no	false

Outputs

no outputs