{"id":18736845,"url":"https://github.com/bitwizeshift/actions-jsonschema","last_synced_at":"2025-11-17T04:30:14.551Z","repository":{"id":226784151,"uuid":"769617174","full_name":"bitwizeshift/actions-jsonschema","owner":"bitwizeshift","description":"JSON Schema Validation provided through a GitHub Action","archived":false,"fork":false,"pushed_at":"2024-11-18T10:42:37.000Z","size":4878,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-28T17:14:03.748Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitwizeshift.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-09T15:27:19.000Z","updated_at":"2024-06-17T02:01:36.000Z","dependencies_parsed_at":"2024-05-06T10:31:16.259Z","dependency_job_id":"2318994f-0dae-43e7-b189-8f51ef6e45b5","html_url":"https://github.com/bitwizeshift/actions-jsonschema","commit_stats":null,"previous_names":["bitwizeshift/actions-jsonschema"],"tags_count":2,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwizeshift%2Factions-jsonschema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwizeshift%2Factions-jsonschema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwizeshift%2Factions-jsonschema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwizeshift%2Factions-jsonschema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitwizeshift","download_url":"https://codeload.github.com/bitwizeshift/actions-jsonschema/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239611993,"owners_count":19668274,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T15:22:42.838Z","updated_at":"2025-11-17T04:30:14.503Z","avatar_url":"https://github.com/bitwizeshift.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JSON Schema Validation Action\n\n[![GitHub Super-Linter](https://github.com/bitwizeshift/actions-jsonschema/actions/workflows/linter.yaml/badge.svg)](https://github.com/super-linter/super-linter)\n![CI](https://github.com/bitwizeshift/actions-jsonschema/actions/workflows/ci.yaml/badge.svg)\n[![Check dist/](https://github.com/bitwizeshift/actions-jsonschema/actions/workflows/check-dist.yaml/badge.svg)](https://github.com/bitwizeshift/actions-jsonschema/actions/workflows/check-dist.yaml)\n[![CodeQL](https://github.com/bitwizeshift/actions-jsonschema/actions/workflows/codeql-analysis.yaml/badge.svg)](https://github.com/bitwizeshift/actions-jsonschema/actions/workflows/codeql-analysis.yaml)\n\nA GitHub action for validating [JSON], [TOML], and [YAML] formatted\nconfiguration files against a [JSON Schema] definition.\n\n[JSON]: https://www.json.org/json-en.html\n[YAML]: https://yaml.org/\n[TOML]: https://toml.io/en/\n[JSON Schema]: https://json-schema.org/\n\n\u003e Convenience [composite actions] are available in addition to the primary\n\u003e `jsonschema` action, such as:\n\u003e\n\u003e - `github-workflow`: which leverages [schemastore]'s [`github-workflow.json`]\n\u003e - `github-action`: which leverages [schemastore]'s [`github-action.json`]\n\u003e - `cargo`: which leverages [schemastore]'s [`cargo.json`]\n\n[`github-workflow.json`]: https://json.schemastore.org/github-workflow.json\n[`github-action.json`]: https://json.schemastore.org/github-action.json\n[`cargo.json`]: https://json.schemastore.org/cargo.json\n[composite actions]:\n  https://docs.github.com/en/actions/creating-actions/creating-a-composite-action\n\n## Features\n\n- [x] Supports [JSON], [YAML], and [TOML] resource validation.\n- [x] Validates schemas from both remote or local definitions.\n- [x] Support for [caching] downloaded schemas to reduce network traffic.\n- [x] Convenience actions which leverage [schemastore] schems.\n\n[schemastore]: https://www.schemastore.org/json/\n\n## Documentation\n\n## Usage\n\n### Pre-requisites\n\nCreate a workflow `.yaml` file in your repository's `.github/workflows`\ndirectory. Some [example workflow](#example-workflows) are available below. For\nmore information, see the GitHub Help Documentation for [Creating a workflow\nfile].\n\n[Creating a workflow file]:\n  https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file\n\n### Inputs\n\n- `paths` - a set of path globs to run this validation against.\n- `schema` - either a path to a local file, or to a URL of a [JSON Schema].\n- `cache-key` - (optional) key to use for caching downloaded schemas. Only\n  relevant when `schema` refers to a URL.\n- `github-token` - (optional) the GitHub API token to use for internal API\n  calls. Default: `${{ github.token }}`.\n- `scope` - (optional) whether to validate `'all'` globbed files, or only ones\n  that have been modified in the `'diff'`. Default: `'all'`.\n\n### Outputs\n\n- `status` - whether validation succeeded. Will be one of `'success'` or\n  `'failure'`.\n\n## Example Workflows\n\n### Validating by local schema\n\n```yaml\nname: Validate against Schema\n\non: push\n\njobs:\n  validate:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v3\n\n      - name: Validate local custom schema\n        uses: bitwizeshift/actions-jsonschema@v1\n        with:\n          schema: ./some-schema.json\n          paths: |\n            testdata/**/*.json\n            resources/**/*.json\n```\n\n### Validating GitHub workflows on change (with caching)\n\n```yaml\nname: Validate GitHub Workflow Schema\n\non:\n  push:\n    paths:\n      - '.github/workflows/*.yaml'\n  pull_request:\n    paths:\n      - '.github/workflows/*.yaml'\n\njobs:\n  validate:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v3\n\n      - name: Validate Workflow Schema\n        uses: bitwizeshift/actions-jsonschema/github-workflow@v1\n        with:\n          paths: ./.github/workflows/*.yaml\n          cache-key: github-workflow\n          scope: diff # Using 'diff' only evaluates files that change\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitwizeshift%2Factions-jsonschema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitwizeshift%2Factions-jsonschema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitwizeshift%2Factions-jsonschema/lists"}