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

📖 Clarify CII-Best-Practices score for each badge #2313

Merged
merged 4 commits into from
Oct 21, 2022

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Sep 30, 2022

What kind of change does this PR introduce?

(Is it a bug fix, feature, docs update, something else?)

Docs update.

What is the current behavior?

Currently it sounds like you get the full 10 for a passing badge.

But the code disagrees:

  • gold: 10
  • silver: 7
  • passing: 5
  • in progress: 2

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

Fix the docs to match the code.

  • [n/a] Tests for the changes have been added (for bug fixes/features)

Which issue(s) this PR fixes

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

@hugovk hugovk temporarily deployed to integration-test September 30, 2022 07:53 Inactive
@github-actions
Copy link

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

docs/checks.md Outdated Show resolved Hide resolved
@naveensrinivasan naveensrinivasan temporarily deployed to integration-test September 30, 2022 12:06 Inactive
@codecov
Copy link

codecov bot commented Sep 30, 2022

Codecov Report

Merging #2313 (1fd77f7) into main (d7c23c9) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2313   +/-   ##
=======================================
  Coverage   40.61%   40.61%           
=======================================
  Files         112      112           
  Lines        8831     8831           
=======================================
  Hits         3587     3587           
  Misses       4984     4984           
  Partials      260      260           

@hugovk hugovk temporarily deployed to integration-test September 30, 2022 12:44 Inactive
@github-actions
Copy link

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

@github-actions
Copy link

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

@spencerschrock
Copy link
Member

Thanks for catching this.

The contents of docs/checks.md are auto-generated. Can you move the changes to docs/checks/internal/checks.yaml?
Afterwards, run make generate-docs and commit both files.

@hugovk
Copy link
Contributor Author

hugovk commented Oct 4, 2022

Done! Spotted a typo at the same time :)

@hugovk hugovk temporarily deployed to integration-test October 4, 2022 18:40 Inactive
@hugovk hugovk temporarily deployed to integration-test October 4, 2022 18:41 Inactive
@github-actions
Copy link

github-actions bot commented Oct 4, 2022

Integration tests success for
[46b21e3]
(https://github.com/ossf/scorecard/actions/runs/3184608404)

@github-actions
Copy link

github-actions bot commented Oct 4, 2022

Integration tests success for
[0cee0d3]
(https://github.com/ossf/scorecard/actions/runs/3184603020)

Copy link
Contributor

@olivekl olivekl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for catching and fixing this!

@github-actions
Copy link

github-actions bot commented Oct 4, 2022

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

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@spencerschrock spencerschrock temporarily deployed to integration-test October 20, 2022 23:30 Inactive
@github-actions
Copy link

Integration tests success for
[1fd77f7]
(https://github.com/ossf/scorecard/actions/runs/3293649997)

@naveensrinivasan naveensrinivasan merged commit 084bcd9 into ossf:main Oct 21, 2022
@hugovk hugovk deleted the patch-1 branch October 21, 2022 06:28
latortuga71 pushed a commit to latortuga71/scorecard that referenced this pull request Oct 27, 2022
* Clarify CII-Best-Practices score for each badge

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Clarify CII-Best-Practices score for each badge

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Move to checks.yaml and regenerate

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Signed-off-by: latortuga <latortugaaaa>
N8BWert pushed a commit to N8BWert/scorecard that referenced this pull request Nov 28, 2022
* Clarify CII-Best-Practices score for each badge

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Clarify CII-Best-Practices score for each badge

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Move to checks.yaml and regenerate

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Signed-off-by: nathaniel.wert <nathaniel.wert@kudelskisecurity.com>
N8BWert pushed a commit to N8BWert/scorecard that referenced this pull request Nov 28, 2022
* Clarify CII-Best-Practices score for each badge

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Clarify CII-Best-Practices score for each badge

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Move to checks.yaml and regenerate

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Signed-off-by: nathaniel.wert <nathaniel.wert@kudelskisecurity.com>
raghavkaul pushed a commit to raghavkaul/scorecard that referenced this pull request Feb 9, 2023
* Clarify CII-Best-Practices score for each badge

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Clarify CII-Best-Practices score for each badge

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Move to checks.yaml and regenerate

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Signed-off-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
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.

4 participants