GitHub Action
JSON Schema Validate
v1.2.0
Latest version
GitHub Action which validates YAML/JSON files against a JSON schema
jobs:
validate-github-actions-workflows:
name: Validate GitHub Actions workflows
permissions:
contents: read
runs-on: ubuntu-latest
steps:
- name: Check for any changed workflows
id: check-for-changed-workflows
uses: tj-actions/changed-files@v41
with:
files: |
.github/workflows/**.yml
- name: Validate workflows
if: steps.check-for-changed-workflows.outputs.any_changed == 'true'
uses: dsanders11/json-schema-validate-action
with:
schema: https://json.schemastore.org/github-workflow.json
files: .github/workflows/**.yml
Schemas can be validated by setting the schema
input to the string literal
json-schema
.
By default the action will cache remote schemas (this can be disabled via the
cache-remote-schema
input). If you need to bust this cache for any reason,
simply set a URL fragment (e.g. #bust-cache
) on the schema URL.
schema
- (required) URL or file path to JSON schema to validate againstfiles
- (required) Multiline input of file paths to validate - supports globsfail-on-invalid
- Whether or not to set action failure if a file is invalid (default:true
)cache-remote-schema
- Whether or not to cache the schema if remote (default:true
)
valid
-true
if all files are valid, otherwisefalse
MIT