https://github.com/dsanders11/json-schema-validate-action

GitHub Action which validates YAML/JSON files against a JSON schema
https://github.com/dsanders11/json-schema-validate-action

github-actions json-schema

Last synced: 9 days ago
JSON representation

GitHub Action which validates YAML/JSON files against a JSON schema

• Host: GitHub
• URL: https://github.com/dsanders11/json-schema-validate-action
• Owner: dsanders11
• License: mit
• Created: 2023-12-28T09:43:43.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-04T17:46:59.000Z (about 1 month ago)
• Last Synced: 2024-10-09T11:42:01.226Z (28 days ago)
• Topics: github-actions, json-schema
• Language: TypeScript
• Homepage:
• Size: 1.26 MB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JSON Schema Validate Action

[![GitHub Super-Linter](https://github.com/dsanders11/json-schema-validate-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)

[![CI](https://github.com/dsanders11/json-schema-validate-action/actions/workflows/ci.yml/badge.svg)](https://github.com/dsanders11/json-schema-validate-action/actions/workflows/ci.yml)

> GitHub Action which validates YAML/JSON files against a JSON schema

## Usage

### Example

```yaml

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

```

### Validating Schema

Schemas can be validated by setting the `schema` input to the string literal

`json-schema`.

### Remote Schema Cache Busting

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.

### Inputs

- `schema` - **(required)** URL or file path to JSON schema to validate against

- `files` - **(required)** Multiline input of file paths to validate - supports

  globs

- `fail-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`)

### Outputs

- `valid` - `true` if all files are valid, otherwise `false`

## License

MIT