Feature: Add a check ID to each check #2577
Comments
|
Stale issue message - this issue will be closed in 7 days |
Open
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The current API only has a string available for a consumer to match, e.g.
{ "name": "Dangerous-Workflow", "reason": "dangerous workflow patterns detected", "details": [ "Warn: untrusted code checkout '${{ github.event.pull_request.head.sha }}': .github/workflows/integration.yml:45" ], "documentation": { "short": "Determines if the project's GitHub Action workflows avoid dangerous patterns.", "url": "https://github.com/ossf/scorecard/blob/c40859202d739b31fd060ac5b30d17326cd74275/docs/checks.md#dangerous-workflow" } },A more easily leveraged approach is the implement a check number. This way people can match against an integer (generally less error prone then string matching). They can then also easily do things such as implement a list of check numbers they wish to ignore.
I recommend something like:
{ "id": 1 "name": "Binary-Artifacts", "score": 10, "reason": "no binaries found in the repo", "details": null, "documentation": { "short": "Determines if the project has generated executable (binary) artifacts in the source repository.", "url": "https://github.com/ossf/scorecard/blob/c40859202d739b31fd060ac5b30d17326cd74275/docs/checks.md#binary-artifacts" } },The text was updated successfully, but these errors were encountered: