ossf / scorecard

OpenSSF Scorecard - Security health metrics for Open Source
https://scorecard.dev
Apache License 2.0
4.46k stars 489 forks source link

:sparkles: announce where results are written #4132

Closed raboof closed 3 months ago

raboof commented 4 months ago

What kind of change does this PR introduce?

Minor usability improvement

What is the current behavior?

When running with '-o foo' the output would end with:

RESULTS
-------

What is the new behavior (if this is a feature change)?**

This was rather confusing. There's of course many ways to make this more clear, this commit adds a log line announcing where the output is written to:

RESULTS
-------
Writing to foo

Which issue(s) this PR fixes

NONE

Special notes for your reviewer

Does this PR introduce a user-facing change?

For user-facing changes, please add a concise, human-readable release note to the release-note

(In particular, describe what changes users might need to make in their application as a result of this pull request.)

NONE
spencerschrock commented 3 months ago

I believe there is a lint that is supposed to prevent new print statements, not sure why it isn't complaining here...

The linter was added primarily from people writing to stdout, so it's not currently configured for fmt.Fprintf which often redirects to a different io.Writer https://github.com/ossf/scorecard/blob/3da6db56c91033e53933000fb7f26e8e617d4b77/.golangci.yml#L93-L96