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

ADR for Scorecard metrics aggregation and stack quality scoring #439

Merged
merged 1 commit into from
Aug 8, 2022

Conversation

mayaCostantini
Copy link
Contributor

Related Issues and Dependencies

Related to #434 and thoth-station/thamos#1148

This introduces a breaking change

  • No

This Pull Request implements

ADR Proposal for aggregating OSSF Scorecards data and computing a software stack quality score.

The logic proposed below would imply to approximate properly the budget allocated to aggregate this data from BigQuery.
To estimate this budget, we would need information about the average number of packages updated with a new release on each package-releases-job run and look more closely at BigQuery pricing according to the API calls we will need to make.

@sesheta sesheta added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 1, 2022

The data aggregation and score computation logic would be implemented as follows:

* With each `package-releases-job` run, aggregate data about the latest package release and corresponding Scorecards data retrieved from BigQuery
Copy link
Member

Choose a reason for hiding this comment

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

Can e use the scorecard command line Utility for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As we want to aggregate data about packages we do not have yet into the prescriptions database, I don't think this will work unless we modify the scorecards handler logic. Another alternative to this architecture would be to compute prescriptions from new releases aggregated on package-release-job without storing this data in the DB, which will (if I'm not mistaken) greatly increase the number of prescriptions we already have. The global quality metrics could then be derived from prescriptions directly and stored in the DB on a regular job run for example.

@goern
Copy link
Member

goern commented Aug 8, 2022

/approve

@sesheta
Copy link
Member

sesheta commented Aug 8, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: goern

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@sesheta sesheta added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 8, 2022
@sesheta sesheta merged commit daaf5f0 into thoth-station:master Aug 8, 2022
@mayaCostantini mayaCostantini deleted the adr-scorecard-metrics branch August 16, 2022 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants