GitHub Actions Example Checker

Check that the examples in your documentation match your GitHub Action's inputs and outputs.

View repository

An action can change while its README examples quietly stay the same. A renamed input or removed output is easy to miss until someone copies an example that no longer works.

GitHub Actions Example Checker looks for action definitions and checks usage examples in your Markdown documentation against them. It can also validate YAML examples embedded in action descriptions and report problems with file and line information in your workflow.

Go beyond input names

An optional action.schema.yml lets you describe input types, allowed values and patterns for more detailed checks. The action can validate output references and help with examples that refer to a fork or its upstream repository. Values containing GitHub Actions expressions are skipped for value validation.

Getting started

Add the checker to a workflow in your action repository. The README explains discovery, configuration and optional schema files; the action is also available on the GitHub Marketplace.

GitHub - jessehouwing/actions-example-checker: Ensures examples match implementation
Ensures examples match implementation. Contribute to jessehouwing/actions-example-checker development by creating an account on GitHub.