feat: readability improvements to OSV record#2
Merged
vsutedjo merged 2 commits intogoogle:mainfrom Mar 20, 2025
Merged
Conversation
This improves the generation of the OSV record: - the summary is human readable - the policy link is included in the details - the details are split over multiple lines So that the record views more nicely at OSV.dev and output from the likes of OSV-Scanner (which may only include the summary) is more user-friendly. Per https://ossf.github.io/osv-schema/#summary-details-fields - the summary is plain text - details is CommonMark markdown
Upon reviewing the README.md and the broader intent of this code, I can see the utility of retaining this as an explicit field and value (for self-documenting), even if it is not currently used.
oliverchang
reviewed
Mar 21, 2025
| "policy_link": "https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/security/updates.md", | ||
| "description": "Dependency on outdated V8 found. Please update to the latest [beta](https://chromium.googlesource.com/v8/v8.git/+/refs/heads/beta), [stable](https://chromium.googlesource.com/v8/v8.git/+/refs/heads/stable), or [extended stable](https://chromium.googlesource.com/v8/v8.git/+/refs/heads/extended) versions." | ||
| "summary": "Outdated dependency on V8 found (see details)", | ||
| "description": "Outdated dependency on V8 found (see [policy](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/security/updates.md).\n\nPlease update to the latest [beta](https://chromium.googlesource.com/v8/v8.git/+/refs/heads/beta), [stable](https://chromium.googlesource.com/v8/v8.git/+/refs/heads/stable), or [extended stable](https://chromium.googlesource.com/v8/v8.git/+/refs/heads/extended) versions." |
There was a problem hiding this comment.
nit: this is missing a ) after the "policy" here.
noticed this on http://test.osv.dev/V8-FRESHNESS
andrewpollock
added a commit
to andrewpollock/chromium-policy-vulnfeed
that referenced
this pull request
Mar 21, 2025
This is a post-merge cosmetic fix to google#2
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 improves the generation of the OSV record:
So that the record views more nicely at OSV.dev
and output from the likes of OSV-Scanner
(which may only include the summary) is more
user-friendly.
Per https://ossf.github.io/osv-schema/#summary-details-fields