mirror of
https://github.com/NVIDIA/OpenShell.git
synced 2026-10-18 05:39:50 +08:00
Simon Scatton
fa7dc26930
* ci(release): add advisory compatibility review Signed-off-by: Simon Scatton <sscatton@nvidia.com> * test(ci): remove compatibility reviewer test harness Signed-off-by: Simon Scatton <sscatton@nvidia.com> * ci(release): run compatibility SDK in the dev shell Signed-off-by: Simon Scatton <sscatton@nvidia.com> * ci(release): trigger a one-shot compatibility review Signed-off-by: Simon Scatton <sscatton@nvidia.com> * ci(release): remove one-shot review trigger Signed-off-by: Simon Scatton <sscatton@nvidia.com> --------- Signed-off-by: Simon Scatton <sscatton@nvidia.com>
106 lines
3.9 KiB
Python
106 lines
3.9 KiB
Python
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
"""Validate agent output and render the advisory compatibility report."""
|
|
|
|
import json
|
|
from html import escape
|
|
from pathlib import Path
|
|
|
|
SURFACES = (
|
|
"rust-sdk",
|
|
"python-sdk",
|
|
"go-sdk",
|
|
"typescript-sdk",
|
|
"api-behavior",
|
|
"cli",
|
|
"configuration",
|
|
"policy",
|
|
"helm",
|
|
"state",
|
|
)
|
|
|
|
|
|
def validate_review(review: dict) -> None:
|
|
fields = {
|
|
"verdict",
|
|
"summary",
|
|
"reviewed_surfaces",
|
|
"unreviewed_surfaces",
|
|
"findings",
|
|
}
|
|
if not isinstance(review, dict) or set(review) != fields:
|
|
raise ValueError("Review is missing required fields or has unexpected fields.")
|
|
if review["verdict"] not in (
|
|
"no_unaddressed_breaks",
|
|
"unaddressed_breaks",
|
|
"needs_review",
|
|
):
|
|
raise ValueError("Review has an invalid verdict.")
|
|
if not isinstance(review["summary"], str) or not review["summary"].strip():
|
|
raise ValueError("Review has no summary.")
|
|
for key in ("reviewed_surfaces", "unreviewed_surfaces"):
|
|
if not isinstance(review[key], list) or any(
|
|
not isinstance(s, str) for s in review[key]
|
|
):
|
|
raise ValueError("Review has invalid coverage.")
|
|
coverage = review["reviewed_surfaces"] + review["unreviewed_surfaces"]
|
|
if len(coverage) != len(SURFACES) or set(coverage) != set(SURFACES):
|
|
raise ValueError("Review must account for every surface exactly once.")
|
|
if review["unreviewed_surfaces"] and review["verdict"] != "needs_review":
|
|
raise ValueError("Incomplete coverage cannot claim a conclusive verdict.")
|
|
if not isinstance(review["findings"], list):
|
|
raise ValueError("Review has invalid findings.")
|
|
for finding in review["findings"]:
|
|
if (
|
|
not isinstance(finding, dict)
|
|
or set(finding)
|
|
!= {"surface", "change", "impact", "evidence", "recommendation"}
|
|
or any(not isinstance(v, str) or not v.strip() for v in finding.values())
|
|
or finding["surface"] not in SURFACES
|
|
):
|
|
raise ValueError(
|
|
"Finding is missing its surface, evidence, impact, or recommendation."
|
|
)
|
|
if review["verdict"] == "unaddressed_breaks" and not review["findings"]:
|
|
raise ValueError("A breaking verdict needs supporting findings.")
|
|
|
|
|
|
def write_report(output: Path, result: dict) -> None:
|
|
output.mkdir(parents=True, exist_ok=True)
|
|
(output / "report.json").write_text(json.dumps(result, indent=2) + "\n")
|
|
context = result["context"]
|
|
lines = [
|
|
"## Compatibility review (advisory)",
|
|
"",
|
|
f"- Execution: **{result['status']}**",
|
|
"- Publication gate: **unchanged**",
|
|
f"- Candidate: `{context.get('candidate_tag', 'unresolved')}` "
|
|
f"(`{context.get('candidate_sha', 'unresolved')}`)",
|
|
f"- Baseline: `{context.get('baseline_tag', 'unresolved')}` "
|
|
f"(`{context.get('baseline_sha', 'unresolved')}`)",
|
|
"",
|
|
]
|
|
if result["error"]:
|
|
lines += [escape(result["error"]), ""]
|
|
review = result["review"]
|
|
if review:
|
|
lines += [
|
|
f"- Assessment: **{review['verdict']}**",
|
|
f"- Reviewed: {', '.join(review['reviewed_surfaces']) or 'none'}",
|
|
f"- Unreviewed: {', '.join(review['unreviewed_surfaces']) or 'none'}",
|
|
"",
|
|
escape(review["summary"]),
|
|
"",
|
|
]
|
|
for finding in review["findings"]:
|
|
lines += [f"### {finding['surface']}", ""]
|
|
for field in ("change", "impact", "evidence", "recommendation"):
|
|
lines += [f"- {field.capitalize()}: {escape(finding[field])}"]
|
|
lines.append("")
|
|
lines += [
|
|
"Agent review is advisory and does not prove the absence of compatibility breaks.",
|
|
"",
|
|
]
|
|
(output / "report.md").write_text("\n".join(lines))
|