Keep your examples in sync with your Action

DEV Community

Sample workflow

In order to add the Actions example checker to your repo, add this workflow:

name: Validate Documentation
on:
 pull_request:
 push:
 branches: [main]
 workflow_dispatch:
permissions: {}
jobs:
 validate-docs:
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 with:
 sparse-checkout: |
 **/action.yaml
 **/action.yml
 **/action.schema.yaml
 **/action.schema.yml
 **/*.md
 sparse-checkout-cone-mode: false
 - uses: jessehouwing/actions-example-checker@ea0821955c7ecf2c98e5b184054ba31486914a7b # v0.0.4
 token: ${{ secrets.GITHUB_TOKEN }}

Example schemas

I've already added schema validation to most of my own actions, they may be able to help you setup your own:

actions-example-checker/action.schema.yaml
actions-semver-checker/action.schema.yaml
actions-dependency-submission/action.schema.yaml
azdo-marketplace/action.schema.yaml

Let me know if you find this useful!