feat: Add a reporter that writes a JSON schema for ORT results #9961
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
plugins/reporters/ort-result-schema/src/main/kotlin/OrtResultSchemaReporter.kt
Fixed
Show fixed
Hide fixed
plugins/reporters/ort-result-schema/src/main/kotlin/OrtResultSchemaReporter.kt
Fixed
Show fixed
Hide fixed
plugins/reporters/ort-result-schema/src/main/kotlin/OrtResultSchemaReporter.kt
Fixed
Show fixed
Hide fixed
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9961 +/- ##
=========================================
Coverage 68.46% 68.46%
Complexity 1309 1309
=========================================
Files 250 250
Lines 8881 8881
Branches 924 924
=========================================
Hits 6080 6080
Misses 2409 2409
Partials 392 392
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
sschuberth
force-pushed
the
ort-result-schema-reporter
branch
2 times, most recently
from
ccb246c to
da1322b
Compare
This is mostly to assist the ORT community with writing external tooling. But it could also be used to detect breaking ORT results changes in the future, and introduce / bump an output file format version. Signed-off-by: Sebastian Schuberth <[email protected]>
sschuberth
force-pushed
the
ort-result-schema-reporter
branch
from
da1322b to
bf33639
Compare
| @@ -0,0 +1,35 @@ | |||
| /* | |||
There was a problem hiding this comment.
commit-msg:
This is mostly to assist the ORT community with writing external
tooling.
Didn't we say that the OrtResult format should not be depended upon externally as it is subject to change?
There was a problem hiding this comment.
Yes, and this PR is not supposed to imply changing that. The ORT result file is and should stay an internal format that can change any time without notice. Which means that also this schema generated by this reporter can change any time. This was just meant as a quick support work for @heliocastro as requested on Slack.
But as I knew this would spawn discussions, I've not dared to take this out of draft state yet.
There was a problem hiding this comment.
I'm just in the schema now, the current jackson support old type of jsonschema. Is ok for you if i update the PR @sschuberth ?
There was a problem hiding this comment.
Is ok for you if i update the PR @sschuberth ?
Update how? Even the latest version of jackson-module-jsonSchema only supports schema V3, and the fork at https://github.com/mbknor/mbknor-jackson-jsonSchema that is supposed to support newer schema versions has not been updated for 4 years.
There was a problem hiding this comment.
There was a problem hiding this comment.
I'll give that one a try. However, we've discussed in today's core dev meeting that a reporter maybe is not the ideal place to implement this after all. I'll probably experiment with something over at https://github.com/sschuberth/ort-scripts.
There was a problem hiding this comment.
I'm closing this PR in favor of the scripting approach. Please give the script a try @heliocastro.
There was a problem hiding this comment.
I like this approach better
No description provided.