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

Feature: use the Scorecard REST API to retrieve the Scorecard result for dependency-diffs #2064

Closed
aidenwang9867 opened this issue Jul 15, 2022 · 7 comments
Labels
kind/enhancement New feature or request Stale

Comments

@aidenwang9867
Copy link
Contributor

Is your feature request related to a problem? Please describe.
In v0 of the Dependency-diff API (issue #2008), we run scorecard checks on every changed dependency to report its check results - and it could be very time-consuming and might easily reach the rate limiting when there is a large number of dependency changes.

Describe the solution you'd like
Use the incoming Scorecard REST API to retrieve the Scorecard result for dependencies statelessly to (1) save time, (2) reduce the token&API usage.

Additional context
This is a TODO introduced in PR #2046.

@aidenwang9867 aidenwang9867 added the kind/enhancement New feature or request label Jul 15, 2022
@aidenwang9867 aidenwang9867 changed the title Feature: use the Scorecare REST API to retrieve the Scorecard result for dependency-diffs Feature: use the Scorecard REST API to retrieve the Scorecard result for dependency-diffs Jul 20, 2022
@aidenwang9867
Copy link
Contributor Author

aidenwang9867 commented Aug 26, 2022

I gave the Scorecard REST API a try and it seems that it already contains many dependency packages - which is great to know! However, since the returned object of GET /projects/{platform}/{org}/{repo} is a JSON object of the repository's ScorecardResult, whereas the DependencyCheckResult structure contains a ScorecardResult rather than a JSON one. We might need some conversion for the API to be used in dependency-diff.

@naveensrinivasan
Copy link
Member

@aidenwang9867 Are you planning to work on this?

@aidenwang9867
Copy link
Contributor Author

aidenwang9867 commented Aug 26, 2022

@aidenwang9867 Are you planning to work on this?

I think I can take this part (changing the running Scorecard mode to query from the REST API) if needed. I don't have much workload at school these days. What's our current plan for this feature? @azeemshaikh38 @laurentsimon

@github-actions
Copy link

This issue is stale because it has been open for 60 days with no activity.

Copy link

This issue is stale because it has been open for 60 days with no activity.

Copy link

github-actions bot commented May 4, 2024

This issue has been marked stale because it has been open for 60 days with no activity.

@github-actions github-actions bot added the Stale label May 4, 2024
@spencerschrock
Copy link
Member

#2008 (comment)

@spencerschrock spencerschrock closed this as not planned Won't fix, can't repro, duplicate, stale Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request Stale
Projects
Status: Done
Development

No branches or pull requests

4 participants