Add infrastructure for validating JSON schemas #2073
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A task and GitHub Actions workflow is added here to validate JSON schema files against the meta-schema. On every push or pull request that affects th 8000 e repository's JSON schema files, and periodically, the workflow will automatically validate the schemas.
Codecov ReportBase: 36.66% // Head: 36.68% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## chore/json-schema #2073 +/- ##
=====================================================
+ Coverage 36.66% 36.68% +0.01%
=====================================================
Files 228 228
Lines 19385 19385
=====================================================
+ Hits 7108 7111 +3
+ Misses 11444 11442 -2
+ Partials 833 832 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
5 tasks
34c68ce to
99eb639
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)What kind of change does this PR introduce?
Infrastructure enhancement
What is the current behavior?
There is no validation of the Arduino CLI configuration file JSON schema. This will increase the burden on contributors to the schema and the reviewers of those contributions.
What is the new behavior?
A task and GitHub Actions workflow is added here to validate JSON schema files against the meta-schema.
On every push or pull request that affects the repository's JSON schema files, and periodically, the workflow will automatically validate the schemas.
The workflow is designed to allow expansion to validation of any number of JSON schemas that might be added to the repository in the future (we had some tentative plans to move the schemas from the Arduino Lint repository to this repo).
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.