Dependency-diff Visualization in Action (version 0 part 1) #651
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces the v0, p1 of my design Dependency-diff Visualization:
Dependency
andVulnerability
;Which issue(s) this PR fixes
The entire design will address the Scorecard issue #2008, in which the v0 addresses 1. fetch dependency-diffs using the GitHub Dependency Review API and 3. parse and visualize the raw dependency-diff results to the PR comment (without detailed vuln info and vuln scores).
Current behavior
The current Scorecard Action only reports the Scorecard results for the repository under analysis. This design will surface Scorecard results for the arriving dependencies in new pull requests.
New behavior of Version Zero (user-facing changes)
With Version Zero, users can see the visualized results of dependency changes in the PR comment section every time they commit their code to a GitHub pull request to the default branch. Detailed dependency changes will be shown, including the dependency change type (added, updated, or removed), the dependency package ecosystem, name, and version. Furthermore, with GitHub Security Advisory (GHSA) as the threat intelligence source, users can view vulnerability information of vulnerable dependencies following its reference link.
Here’s a quick example of what Version Zero looks like.