Skip to content

Improve critical vulnerability scan summaries #21499

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
geropl merged 1 commit into from
Jun 22, 2026
+120 −2
Merged

Improve critical vulnerability scan summaries #21499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
61 changes: 60 additions & 1 deletion .github/workflows/branch-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,65 @@ jobs:
shell: bash
run: |
# Parse vulnerability-stats.json from the scans directory
CRITICAL_PACKAGES=$(jq -r '.[] | select(.critical > 0) | "\(.name): \(.critical) critical vulnerabilities"' "${{ steps.scan.outputs.leeway_vulnerability_reports_dir }}/vulnerability-stats.json")
SCANS_DIR="${{ steps.scan.outputs.leeway_vulnerability_reports_dir }}"
CRITICAL_PACKAGES=$(jq -r '.[] | select(.critical > 0) | "\(.name): \(.critical) critical vulnerabilities"' "$SCANS_DIR/vulnerability-stats.json")

package_from_report() {
local package
package="$(basename "$1" .json)"
package="${package//--/:}"

for prefix in components dev install test; do
if [[ "$package" == "$prefix-"* ]]; then
package="$prefix/${package#"$prefix-"}"
break
fi
done

printf '%s' "$package"
}

append_critical_finding_summary() {
{
echo
echo "### Critical vulnerability details"
echo
echo "| Affected package | Vulnerability | Artifact | Version | Location | Fix state / fixed version |"
echo "| --- | --- | --- | --- | --- | --- |"
} >> "$GITHUB_STEP_SUMMARY"

details_found=false
while IFS= read -r -d '' report; do
package="$(package_from_report "$report")"
details="$(
jq -r --arg package "$package" '
def md_escape:
tostring
| gsub("\r"; " ")
| gsub("\n"; "<br>")
| gsub("\\|"; "\\|");

.matches[]?
| select((.vulnerability.severity // "" | ascii_downcase) == "critical")
| ((.artifact.locations // []) | map(.path // .layerID // "unknown") | unique | join("<br>")) as $locations
| (.vulnerability.fix.state // "unknown") as $fix_state
| ((.vulnerability.fix.versions // []) | unique | join(", ")) as $fixed_versions
| (if $locations == "" then "unknown" else $locations end) as $location_display
| (if $fixed_versions == "" then $fix_state else "\($fix_state): \($fixed_versions)" end) as $fix_display
| "| `\($package | md_escape)` | `\((.vulnerability.id // "unknown") | md_escape)` | `\((.artifact.name // "unknown") | md_escape)` | `\((.artifact.version // "unknown") | md_escape)` | `\($location_display | md_escape)` | `\($fix_display | md_escape)` |"
' "$report"
)"

if [ -n "$details" ]; then
details_found=true
echo "$details" >> "$GITHUB_STEP_SUMMARY"
fi
done < <(find "$SCANS_DIR" -maxdepth 1 -name '*.json' ! -name 'vulnerability-stats.json' -print0 | sort -z)

if [ "$details_found" = false ]; then
echo "_No detailed critical findings were present in the report JSON files._" >> "$GITHUB_STEP_SUMMARY"
fi
}

# If there are critical packages, list them and fail the build
if [ -n "$CRITICAL_PACKAGES" ]; then
Expand All @@ -385,6 +443,7 @@ jobs:
echo "affected_packages<<EOF" >> $GITHUB_OUTPUT
echo "$CRITICAL_PACKAGES" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
append_critical_finding_summary
exit 1
else
echo "No critical vulnerabilities found."
Expand Down
61 changes: 60 additions & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,65 @@ jobs:
shell: bash
run: |
# Parse vulnerability-stats.json from the scans directory
CRITICAL_PACKAGES=$(jq -r '.[] | select(.critical > 0) | "\(.name): \(.critical) critical vulnerabilities"' "${{ steps.scan.outputs.leeway_vulnerability_reports_dir }}/vulnerability-stats.json")
SCANS_DIR="${{ steps.scan.outputs.leeway_vulnerability_reports_dir }}"
CRITICAL_PACKAGES=$(jq -r '.[] | select(.critical > 0) | "\(.name): \(.critical) critical vulnerabilities"' "$SCANS_DIR/vulnerability-stats.json")

package_from_report() {
local package
package="$(basename "$1" .json)"
package="${package//--/:}"

for prefix in components dev install test; do
if [[ "$package" == "$prefix-"* ]]; then
package="$prefix/${package#"$prefix-"}"
break
fi
done

printf '%s' "$package"
}

append_critical_finding_summary() {
{
echo
echo "### Critical vulnerability details"
echo
echo "| Affected package | Vulnerability | Artifact | Version | Location | Fix state / fixed version |"
echo "| --- | --- | --- | --- | --- | --- |"
} >> "$GITHUB_STEP_SUMMARY"

details_found=false
while IFS= read -r -d '' report; do
package="$(package_from_report "$report")"
details="$(
jq -r --arg package "$package" '
def md_escape:
tostring
| gsub("\r"; " ")
| gsub("\n"; "<br>")
| gsub("\\|"; "\\|");

.matches[]?
| select((.vulnerability.severity // "" | ascii_downcase) == "critical")
| ((.artifact.locations // []) | map(.path // .layerID // "unknown") | unique | join("<br>")) as $locations
| (.vulnerability.fix.state // "unknown") as $fix_state
| ((.vulnerability.fix.versions // []) | unique | join(", ")) as $fixed_versions
| (if $locations == "" then "unknown" else $locations end) as $location_display
| (if $fixed_versions == "" then $fix_state else "\($fix_state): \($fixed_versions)" end) as $fix_display
| "| `\($package | md_escape)` | `\((.vulnerability.id // "unknown") | md_escape)` | `\((.artifact.name // "unknown") | md_escape)` | `\((.artifact.version // "unknown") | md_escape)` | `\($location_display | md_escape)` | `\($fix_display | md_escape)` |"
' "$report"
)"

if [ -n "$details" ]; then
details_found=true
echo "$details" >> "$GITHUB_STEP_SUMMARY"
fi
done < <(find "$SCANS_DIR" -maxdepth 1 -name '*.json' ! -name 'vulnerability-stats.json' -print0 | sort -z)

if [ "$details_found" = false ]; then
echo "_No detailed critical findings were present in the report JSON files._" >> "$GITHUB_STEP_SUMMARY"
fi
}

# If there are critical packages, list them and fail the build
if [ -n "$CRITICAL_PACKAGES" ]; then
Expand All @@ -388,6 +446,7 @@ jobs:
echo "affected_packages<<EOF" >> $GITHUB_OUTPUT
echo "$CRITICAL_PACKAGES" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
append_critical_finding_summary
exit 1
else
echo "No critical vulnerabilities found."
Expand Down
Loading