feat: add $schema to outputted files #471
Merged
Conversation
This file contains 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
dbjorge
changed the title
dbjorge
approved these changes
Nov 5, 2020
There was a problem hiding this comment.
Thanks for the contribution! This looks good to me. @peterdur and I discussed and we think we'd like to treat this as a non-breaking feature; I've update the PR title accordingly.
We feel a little reluctant about using the master branch of the sarif-spec repo rather than pinning to a specific commit/tag, since we've been impacted in the past by that repo merging breaking changes without incrementing versions in filenames. But we think consistency with the spec's recommendation and the schema's $id property is more important, so we'll go with this as-is.
|
This has been released in v2.6.0 |
|
🎉 This PR is included in version 2.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Description of changes
Add's a $schema value to the outputted Sarif file.
Some places, in particular GitHub require a $schema field to be populated
This code adds that schema url using the value from the spec. Tests have been updated to include the field.
I have validated that this change is inline with the Sarif spec
Please let me know if this should be treated as a breaking change as the outputs have changed.
Pull request checklist
fix:,feat:, etc, and is suitable for user-facing release notes)BREAKING CHANGE:yarn precheckin