/json-schema-validator

A Github Action for validating JSON using specified JSON schema.

Primary LanguagePython

JSON Schema Validator

A Github Action for validating JSON using specified JSON schema.

How to use it?

Create .github/workflows/<workflow_name>.yml

on:
  pull_request:
    branches:
      - master
name: Pull request workflow
jobs:
  validate_configurations:
    name: Validate configurations
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Validate BigQuery schema
        uses: snapcart/json-schema-validator@v1.0.0
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          json_schema: ./schemas/bigquery_schema.schema
          json_path_pattern: .*bigquery_schema.json$
          send_comment: true
          clear_comments: true
      - name: Validate other schema
        uses: snapcart/json-schema-validator@v1.0.0
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          json_schema: ./schemas/other_schema.schema
          json_path_pattern: .*other_schema.json$
Inputs Required Default Description
token Yes - GitHub token to access pull request details. GitHub provides one here ${{ secrets.GITHUB_TOKEN }}
json_schema Yes - Path to the JSON Schema to validate with
json_path_pattern Yes - Path to JSON files in RegEx
send_comment No False Create a comment containing validation errors
clear_comments No False Clear previous error comment(s)