Skip to content

Fix report step crashing on runs with no pull request #4

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
ralyodio merged 1 commit into from
Aug 1, 2026
Merged

Fix report step crashing on runs with no pull request #4

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
23 changes: 19 additions & 4 deletions scripts/generate-report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,12 @@ def main() -> int:
parser = argparse.ArgumentParser(description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument("--sarif", required=True, type=Path)
parser.add_argument("--pr-number", type=int, help="omit to skip commenting")
# Deliberately a string, not an int. On a workflow_dispatch or push run there
# is no pull request, so the workflow interpolates an empty value here and an
# int converter would abort the whole step. An absent PR is a normal state:
# write the summary, skip the comment.
parser.add_argument("--pr-number", default="",
help="pull request number; empty or omitted skips commenting")
parser.add_argument("--repo", help="owner/name")
parser.add_argument("--coverage", type=Path, default=Path("coverage-report.json"),
help="optional coverage report to fold into the comment")
Expand All @@ -213,11 +218,21 @@ def main() -> int:
with open(step_summary, "a", encoding="utf-8") as handle:
handle.write(body + "\n")

pr_number = str(args.pr_number).strip()
if pr_number and not pr_number.isdigit():
print(f"warning: --pr-number {pr_number!r} is not a number — skipping the comment",
file=sys.stderr)
pr_number = ""

token = os.environ.get("GITHUB_TOKEN")
if args.pr_number and args.repo and token:
upsert_comment(args.repo, args.pr_number, body, token)
elif args.pr_number and not token:
if not pr_number:
print("no pull request in context — summary written, comment skipped")
elif not args.repo:
print("note: --repo not given — skipping the PR comment", file=sys.stderr)
elif not token:
print("note: GITHUB_TOKEN is not set — skipping the PR comment", file=sys.stderr)
else:
upsert_comment(args.repo, pr_number, body, token)

# Reporting never fails the build; the scan step owns the pass/fail decision.
return 0
Expand Down
Loading