✨ Add a --details-format Option to produce JSON-details
#2910
Conversation
laurentsimon
requested review from
azeemshaikh38,
justaugustus,
naveensrinivasan,
spencerschrock and
raghavkaul
as code owners
laurentsimon
had a problem deploying
to
integration-test
GitHub Actions
Failure
laurentsimon
had a problem deploying
to
integration-test
GitHub Actions
Failure
laurentsimon
had a problem deploying
to
integration-test
GitHub Actions
Failure
| DetailsFormatString = "string" | ||
| // DetailsFormatFindings specifies that the details will be reported as "structured" findings | ||
| // that are more suited for automated parsing. | ||
| DetailsFormatFinding = "finding" |
There was a problem hiding this comment.
I'm looking for feedback of what to name this details' format.
laurentsimon
had a problem deploying
to
integration-test
GitHub Actions
Failure
laurentsimon
had a problem deploying
to
integration-test
GitHub Actions
Failure
laurentsimon
temporarily deployed
to
integration-test
GitHub Actions
Inactive
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #2910 +/- ##
=======================================
Coverage 52.42% 52.43%
=======================================
Files 158 158
Lines 12108 12146 +38
=======================================
+ Hits 6348 6369 +21
- Misses 5390 5407 +17
Partials 370 370 |
There was a problem hiding this comment.
I'm a bit confused at the purpose of this flag.
Do you imagine the need for --format json users to use the finding detail format as well? Or for --format structured-json users to use the string detail format?
I don't really see a difference in output when running these commands:
SCORECARD_EXPERIMENTAL=1 go run main.go --repo ossf/scorecard --format structured-json --details-format string --show-details
SCORECARD_EXPERIMENTAL=1 go run main.go --repo ossf/scorecard --format structured-json --details-format finding --show-details
| @@ -116,7 +116,7 @@ func FormatResults( | |||
| // TODO: support config files and update checker.MaxResultScore. | |||
| err = results.AsSARIF(opts.ShowDetails, log.ParseLevel(opts.LogLevel), os.Stdout, doc, policy, opts) | |||
| case options.FormatJSON: | |||
| err = results.AsJSON2(opts.ShowDetails, log.ParseLevel(opts.LogLevel), doc, os.Stdout) | |||
| err = results.AsJSON3(opts, log.ParseLevel(opts.LogLevel), doc, os.Stdout) | |||
There was a problem hiding this comment.
I'd be hesitant with this change. I thought this was enabling the JSONScorecardResultV3 for the --format json users.
This is misleading in my opinion.
|
Closing this PR. Based on @spencerschrock 's comment, I don't think it's needed. Re-using |
This PR:
--details-formatoption to the CLI, gated onSCORECARD_EXPERIMENTAL=1.