Introduce OpenSSF Best Practices Badge rule #238
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a rule that ensures that the project has an OpenSSF Best Practices badge at the specified level (defaulting to: "passing"). This is driven by the OpenSSF Best Practices data source, which queries bestpractices.dev. Add the new rule type to the OpenSSF Scorecard profile.
ethomson
force-pushed
the
ethomson/badge
branch
from
47e7266 to
ef21e81
Compare
JAORMX
reviewed
Dec 19, 2024
| # Defines the configuration for alerting on the rule | ||
| alert: | ||
| type: security_advisory | ||
| security_advisory: {} |
There was a problem hiding this comment.
nit: Should we stop adding the security_advisory alert? we probably want to deprecate this anyway.
There was a problem hiding this comment.
Yes but I think that it makes sense to burn it down so that the rules are consistent with each other, instead of having a few that are one way and a few that are another.
JAORMX
reviewed
Dec 19, 2024
| version: v1 | ||
| release_phase: alpha | ||
| type: rule-type | ||
| name: openssf_bestpractices |
There was a problem hiding this comment.
This must match the file name.
| guidance: | | ||
| The [OpenSSF Best Practices Badge](https://www.bestpractices.dev/en) | ||
| program allows open source projects to show that they follow best | ||
| security practices. |
There was a problem hiding this comment.
This guidance looks a little off. The intent is to tell people what to do if they fail this check.
|
Updated in #243 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a rule that ensures that the project has an OpenSSF Best Practices badge at the specified level (defaulting to: "passing"). This is driven by the OpenSSF Best Practices data source, which queries bestpractices.dev.
Add the new rule type to the OpenSSF Scorecard profile.