Skip to content

Omit patched_versions: if the GHSA has no patched version identifiers. #664

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.

Sign up for GitHub

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

Merged
postmodern merged 3 commits into from
Jul 1, 2023
Merged

Omit patched_versions: if the GHSA has no patched version identifiers. #664

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fa784b
Omit `patched_versions:` if the GHSA has no patched version identifiers.
postmodern Jun 29, 2023
90f8caa
Also check if the `identifier` key is set.
postmodern Jun 30, 2023
2fee933
Guard against when ``first_patched_versions_for` returns an empty Array.
postmodern Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions lib/github_advisory_sync.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,9 @@ def first_patched_versions_for(package)
first_patched_versions = []

vulnerabilities.each do |v|
if v['package']['name'] == package.name && v['firstPatchedVersion']
if v['package']['name'] == package.name &&
v['firstPatchedVersion'] &&
v['firstPatchedVersion']['identifier']
first_patched_versions << v['firstPatchedVersion']['identifier']
end
end
Expand All @@ -353,11 +355,13 @@ def patched_versions_for(package)
first_patched_versions = first_patched_versions_for(package)
patched_versions = []

first_patched_versions[0..-2].each do |version|
patched_versions << "~> #{version}"
end
if !first_patched_versions.empty?
first_patched_versions[0..-2].each do |version|
patched_versions << "~> #{version}"
end

patched_versions << ">= #{first_patched_versions.last}"
patched_versions << ">= #{first_patched_versions.last}"
end

return patched_versions
end
Expand All @@ -371,15 +375,23 @@ def create(package)
"unaffected_versions" => ["<OPTIONAL: FILL IN SEE BELOW>"]
)

patched_versions = patched_versions_for(package)

if !patched_versions.empty?
new_data['patched_versions'] = patched_versions
else
new_data['notes'] = "Never patched"
end

# populate the related information
new_data["related"] = {
"url" => advisory["references"]
}

FileUtils.mkdir_p(File.dirname(filename_to_write))
File.open(filename_to_write, "w") do |file|
# create an automatically generated advisory yaml file
file.write new_data.merge(
"patched_versions" => patched_versions_for(package),
"related" => {
"url" => advisory["references"]
}
).to_yaml
file.write new_data.to_yaml

# The data we just wrote is incomplete,
# and therefore should not be committed as is
Expand Down