jessehouwing/Actions Example Checker

Validate examples in documentation against action.yml schemas

View on GitHub

Trust Signals

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

Pinned Snippet

workflow.ymlSHA-pinned
uses: jessehouwing/actions-example-checker@eb2c287585cd48847abc0d3012e861918793561f # v0.0.11

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

namedescriptionrequireddefault
tokenGitHub token for API access to check fork relationships. When provided, the action will detect if the repository is a fork and allow examples to reference either the fork name or the upstream parent name. no${{ github.token }}
versionOne or more versions that action references in examples must use. Accepts comma and/or newline-separated version strings (e.g. "v1, v1.2, v1.2.3"). When not provided, version checking is skipped and a warning is emitted. no
repositoryRepository name in 'owner/repo' format. Used to match action references in documentation. If not provided, will be auto-detected from git or GITHUB_REPOSITORY environment variable. no
repository-pathPath to the repository root (defaults to current directory)no.
action-patternGlob pattern to find action files (e.g., **/action.{yml,yaml})no{**/,}action.{yml,yaml}
docs-patternGlob pattern to find documentation files (e.g., **/*.md)no**/*.md
namedescription
errors-foundNumber of validation errors found
files-checkedNumber of documentation files checked