-
Notifications
You must be signed in to change notification settings - Fork 581
Closed
Milestone
Description
Is your feature request related to a problem? Please describe.
Scorecard should provide a badge for repositories to include in their README to display their compliance.
Scorecard badges
The scorecard should provide badges similar to other https://github.com/badges/shields OSS badges for compliance.
Goals
- Scorecard should provide badge results based on scorecard runs on the (cron)server to ensure compliance and validation. Similar to Codecov.
- Scorecard should provide a predictable API to fetch the badges. An example could be https://somefqdn/github/ossf/scorecard/badge
- Scorecard results calculation - TBD - The discussion of calculation should be a separate issue.
Implementaion
- Scorecard would create a separate HTTP application (within the scorecard repository) which would generate the badge.
- Scorecard would use the Results from the scheduled cron run to generate the badge. The results of the cron are stored within the GCS bucket as
latest.json - The HTTP application would be stateless.
- The application would be hosted on Google Cloud Run which will scalability with less maintenance.
In this example
- The k8s repository README.md would request the scorecard badge service for the badge
- The badge service would fetch the results from the GC bucket which has the
latest.jsonresults from the cron job - The badge service calculates the score and returns the SVG.
Metadata
Metadata
Assignees
Labels
No labels