Releases: GrantBirki/json-yaml-validate
Release list
v5.0.0
v5.0.0
TL;DR
v5 is a major release for json-yaml-validate: the action now runs on node24, the internals have been rewritten in TypeScript, the runtime dependency surface is much smaller, path handling is stricter, and several new validation workflows are supported.
Most users can start by changing workflow references from GrantBirki/json-yaml-validate@v4 to GrantBirki/json-yaml-validate@v5, but please review the v4 to v5 migration guide before updating protected CI jobs.
Highlights
- Rewrote the action from JavaScript to TypeScript and moved the runtime to
node24. - Reduced runtime dependencies by replacing several packages with native implementations for action core behavior, PR comments, file discovery, coverage badge generation, and legacy YAML schema validation.
- Hardened validation path handling so explicit files, schemas, base directories, and schema mappings must resolve to regular files or directories inside the workspace.
- Allowed multi-document YAML by default, matching common Kubernetes-style YAML usage. Set
allow_multiple_documents: "false"to preserve the old default. - Added support for single-line, space-separated
filesinput values. - Added
schema_mappingsfor validating different file groups against different JSON or YAML schemas in one action step. - Added local-only inline schema discovery with
use_inline_schemafor JSON$schemareferences and YAML language-server schema comments whenyaml_as_jsonis enabled. - Added
comment_on_successandupdate_commentso PR comments can be less noisy while still surfacing validation status. - Strengthened tests, acceptance coverage, workflow hardening, package checks, and CI coverage thresholds.
Upgrade Notes
- Self-hosted runners must support JavaScript actions that run on
node24. - v5 intentionally rejects validation paths that escape the checked-out workspace or resolve through symlinks outside the workspace.
- File paths in logs and PR comments now prefer workspace-relative paths.
- JSON schema file skipping is now exact after realpath normalization, rather than substring-based.
update_commentonly updates matching validation comments authored bygithub-actions[bot].
See the full migration guide for examples and compatibility notes.
What's Changed
- Bump github/codeql-action from 3 to 4 in the github-actions group by @dependabot[bot] in #96
- Add agent guide by @GrantBirki in #118
- Harden unit test coverage by @GrantBirki in #119
- Harden acceptance coverage by @GrantBirki in #120
- Slim Node dependencies by @GrantBirki in #122
- Update Node dependencies by @GrantBirki in #123
- Migrate action to TypeScript by @GrantBirki in #124
- Consolidate agent guidance by @GrantBirki in #125
- Pin workflow action references by @GrantBirki in #126
- Support flat files input lists by @GrantBirki in #127
- Add success PR comments by @GrantBirki in #128
- Support updating PR comments by @GrantBirki in #129
- Fix YAML schema keyword field validation by @GrantBirki in #130
- Fix JSON meta-schema validation by @GrantBirki in #131
- Update AGENTS guidance from issue work by @GrantBirki in #132
- Support schema mappings by @GrantBirki in #133
- Support local inline schemas by @GrantBirki in #134
- Default to multi-document YAML validation by @GrantBirki in #135
- Update fast-uri security patch by @GrantBirki in #136
- Deduplicate validation file outcomes by @GrantBirki in #137
- Harden action workflows and PR comment updates by @GrantBirki in #138
- Harden validation path handling by @GrantBirki in #139
- Add v5 migration guide by @GrantBirki in #141
- Normalize schema mapping overlap checks by @GrantBirki in #140
- Update docs examples for v5 by @GrantBirki in #142
- Strengthen branch coverage tests by @GrantBirki in #143
Full Changelog: v4.0.0...v5.0.0
v4.0.0
What's Changed
🚨 Breaking change notice: The vast majority of users should be able to seamlessly upgrade to v4 without needing to make any changes at all. This is mainly just a major version release due to the fact that this Action is moving to a default runtime of node24 which requires up-to-date Actions runner versions.
- Bump brace-expansion from 1.1.11 to 1.1.12 in the npm_and_yarn group across 1 directory by @dependabot[bot] in #92
- update all internal node deps by @GrantBirki in #93
- upgrade to
node24by @GrantBirki in #94 - Repo/actions dependency updates by @GrantBirki in #95
Full Changelog: v3.3.2...v4.0.0
v3.3.2
What's Changed
- TLC and General Improvements by @GrantBirki in #88
- More Robust Tests 🧪 - Comprehensive test coverage improvements by @copilot-swe-agent in #90
- Fix file duplication issue - YAML validator now skips JSON files when not in yamlAsJson mode by @copilot-swe-agent in #91
New Contributors
- @copilot-swe-agent made their first contribution in #90
Full Changelog: v3.3.1...v3.3.2
v3.3.1
What's Changed
- bug:
allow_multiple_documentscrashes the action in certain JSON parsing cases by @GrantBirki in #87
Full Changelog: v3.3.0...v3.3.1
v3.3.0
What's Changed
- Bump cross-spawn from 7.0.3 to 7.0.6 in the npm_and_yarn group across 1 directory by @dependabot in #79
- Changing JSON validator to be able to deal with multiple docs when YAML is treated as JSON by @juheiseflink in #84
- Bump undici from 5.28.4 to 5.28.5 in the npm_and_yarn group across 1 directory by @dependabot in #82
- Node Updates by @GrantBirki in #85
New Contributors
- @juheiseflink made their first contribution in #84
Full Changelog: v3.2.1...v3.3.0
v3.2.1
What's Changed
- Flat YAML acceptance tests by @GrantBirki in #75
- Fix file validation in action summary by @GrantBirki in #76
Full Changelog: v3.2.0...v3.2.1
v3.2.0
What's Changed
- Adding
draft-04support for JSON validations by @GrantBirki in #74
Full Changelog: v3...v3.2.0
v3.1.0
What's Changed
- Bump braces from 3.0.2 to 3.0.3 in the npm_and_yarn group across 1 directory by @dependabot in #71
- Feature: Allow non-existing exclude file by @GrantBirki in #72
- Node Package Updates by @GrantBirki in #73
Full Changelog: v3...v3.1.0
v3.0.0
What's Changed
- Better gitignore support by @GrantBirki in #66
Full Changelog: v2...v3.0.0
v2.7.1
What's Changed
Full Changelog: v2.7.0...v2.7.1