Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Remove erroneous ref to CSV output #1813

Merged
merged 1 commit into from
May 9, 2022
Merged

Conversation

lehors
Copy link
Contributor

@lehors lehors commented Apr 4, 2022

Signed-off-by: Arnaud J Le Hors [email protected]

What kind of change does this PR introduce?

docs update

What is the current behavior?

README claims that CSV output format is supported.

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

README only lists default and json as output formats.

  • Tests for the changes have been added (for bug fixes/features)

NA.

Which issue(s) this PR fixes

NONE

Special notes for your reviewer

I actually happen to regret the drop of CSV output support but at least the documentation should be consistent with the code.

Does this PR introduce a user-facing change?

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

Yes, the README no longer misleads the user.

Update README to reflect actual list of supported output formats.

@lehors lehors requested a review from olivekl as a code owner April 4, 2022 12:58
@lehors lehors temporarily deployed to integration-test April 4, 2022 12:59 Inactive
Copy link
Member

@naveensrinivasan naveensrinivasan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@codecov
Copy link

codecov bot commented Apr 4, 2022

Codecov Report

Merging #1813 (f356a94) into main (5758364) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1813   +/-   ##
=======================================
  Coverage   51.27%   51.27%           
=======================================
  Files          80       80           
  Lines        6797     6797           
=======================================
  Hits         3485     3485           
  Misses       3081     3081           
  Partials      231      231           

@github-actions
Copy link

github-actions bot commented Apr 4, 2022

Integration tests success for
[3c8be1e]
(https://github.com/ossf/scorecard/actions/runs/2089991687)

@lehors lehors changed the title Remove erroneous ref to CSV output (:book:) Remove erroneous ref to CSV output Apr 4, 2022
@lehors lehors changed the title (:book:) Remove erroneous ref to CSV output 📖 Remove erroneous ref to CSV output Apr 4, 2022
Copy link
Member

@justaugustus justaugustus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny nits on the language.
In addition to mentioning the format options, we should specify what default actually means (outputting as a table).

Could you mention this in the flags as well?

README.md Outdated Show resolved Hide resolved
@lehors lehors temporarily deployed to integration-test April 4, 2022 14:43 Inactive
@github-actions
Copy link

github-actions bot commented Apr 4, 2022

Integration tests success for
[518df3e]
(https://github.com/ossf/scorecard/actions/runs/2090617226)

@lehors lehors temporarily deployed to integration-test April 4, 2022 15:12 Inactive
@github-actions
Copy link

github-actions bot commented Apr 4, 2022

Integration tests success for
[059d9c2]
(https://github.com/ossf/scorecard/actions/runs/2090726279)

@lehors lehors temporarily deployed to integration-test April 8, 2022 14:13 Inactive
@github-actions
Copy link

github-actions bot commented Apr 8, 2022

Integration tests success for
[d6f4afd]
(https://github.com/ossf/scorecard/actions/runs/2115649430)

@github-actions
Copy link

Stale pull request message

@lehors
Copy link
Contributor Author

lehors commented Apr 19, 2022

Tiny nits on the language. In addition to mentioning the format options, we should specify what default actually means (outputting as a table).

Could you mention this in the flags as well?

@justaugustus Done. Thanks.

@lehors lehors temporarily deployed to integration-test April 19, 2022 05:50 Inactive
@github-actions
Copy link

Integration tests success for
[2c74788]
(https://github.com/ossf/scorecard/actions/runs/2187764663)

@lehors lehors temporarily deployed to integration-test April 28, 2022 20:23 Inactive
@github-actions
Copy link

Integration tests success for
[aad643d]
(https://github.com/ossf/scorecard/actions/runs/2241732258)

@github-actions
Copy link

github-actions bot commented May 9, 2022

Stale pull request message

@lehors lehors temporarily deployed to integration-test May 9, 2022 11:45 Inactive
@lehors
Copy link
Contributor Author

lehors commented May 9, 2022

I realize this isn't the most exciting PR maintainers might dream of but I would advise them to be a bit more diligent in merging PRs from the community. It is not a very pleasant experience to have to keep rebasing your PRs because it is being left unattended by the maintainers. @justaugustus could you please help?
Thanks.

Copy link
Member

@justaugustus justaugustus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I realize this isn't the most exciting PR maintainers might dream of but I would advise them to be a bit more diligent in merging PRs from the community. It is not a very pleasant experience to have to keep rebasing your PRs because it is being left unattended by the maintainers.

Thanks for the PR, @lehors!
As a note, several of the maintainers are preparing for conferences and other events, hence the delayed reviews.

@justaugustus justaugustus enabled auto-merge (squash) May 9, 2022 12:08
@github-actions
Copy link

github-actions bot commented May 9, 2022

Integration tests success for
[f356a94]
(https://github.com/ossf/scorecard/actions/runs/2293933097)

@justaugustus justaugustus merged commit 815de18 into ossf:main May 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants