You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently if a project doesn't use the Scorecard action, the Scorecard Viewer will only display the checks that are evaluated at the cron job(which excludes some important checks like Dependency-Update-Tool or Contributors), but this is not transparent for the user.
In fact, the lack of those checks will end up with an overall score that is different from the one got by the Scorecard API or got when you install Scorecard actions. That can be very frustrating as some maintainers like to have a preview of their score before installing Scorecard.
If we make clear that using the Scorecard Action would enable the other inspections, it could also motivate the adoption of the tool.
Purposed Solution
I've thought of these two actions:
The viewer displays all Scorecard checks, but greys out the checks that could not be evaluated.
A note is displayed above the viewer, explaining the situation. Such as "Some of the checks could not be evaluated and are grayed out -- their exclusion might affect the overall Score of the project. To include them on the analysis, please install Scorecard Action on the analyzed repository, or run Scorecard through our Command Line Client"
The text was updated successfully, but these errors were encountered:
Note: we don't currently surface whether or not the API result comes from the cron or from the action. So it may not be possible to try and push people towards the action.
Makes sense... Does the missing checks come as -1? We could just show all "-1"s as greyed out, and adapt the note to indicate that some of the greyed out checks may be because of lack of permissions, and using the Action or running at the CLI might include other checks. If some -1 keep appearing at the CLI/action evaluation because of other reasons, at least the overall score would be coherent.
Motivation
Currently if a project doesn't use the Scorecard action, the Scorecard Viewer will only display the checks that are evaluated at the cron job(which excludes some important checks like Dependency-Update-Tool or Contributors), but this is not transparent for the user.
In fact, the lack of those checks will end up with an overall score that is different from the one got by the Scorecard API or got when you install Scorecard actions. That can be very frustrating as some maintainers like to have a preview of their score before installing Scorecard.
If we make clear that using the Scorecard Action would enable the other inspections, it could also motivate the adoption of the tool.
Purposed Solution
I've thought of these two actions:
The text was updated successfully, but these errors were encountered: