Skip to content

fix(review): show the cause of Review Readiness failures in annotations - #5575

Open
purp wants to merge 6 commits into
NVIDIA:mainfrom
purp:fix/5573-review-readiness-errors/purp
Open

purp wants to merge 6 commits into
NVIDIA:mainfrom
purp:fix/5573-review-readiness-errors/purp

Conversation

@purp

@purp purp commented Nov 14, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Review Readiness failures now report their cause as a GitHub error annotation, so the run page and PR checks list show why the check failed instead of only "Process completed with exit code 1."

Related Issue

Closes #5573

The linked issue lacks state:accepted; the author has ADMIN access to this repository.

Changes

  • check_review_readiness.py prints ::error title=Review Readiness: <category>::<message> when GITHUB_ACTIONS is true. Outside Actions the output is the same plain Review readiness: … line as before.
  • gh api failures name the step that failed (for example, "Requesting reviewers failed with a GitHub API error"), then give the method, path, exit status and the error text gh printed. The --input payload is never printed.
  • Label failures say what is wrong with this PR's labels, name them, and say how to fix them. Once the labeling agent can repair these, feat(review): let the labeling agent repair label defects before Review Readiness fails #5578 removes that guidance.
  • Which cases fail the check is unchanged; failures still exit 1.

Release Notes

Testing

  • Checks appropriate to the affected code and behavior pass
  • Unit tests added/updated (if applicable)
  • E2E tests added/updated (if applicable)

mise run test:review-readiness passes (58 tests, with and without GITHUB_ACTIONS=true), ruff check and ruff format --check pass, and the pre-commit hook passed on each commit. The workflow runs on pull_request_target and uses the script from main, so this PR's own run does not exercise the change. The annotation on a real run can be confirmed after merge by giving a ready PR two area: labels.

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

purp added 3 commits November 14, 2026 14:34
Signed-off-by: Jim Meyer <jimeyer@nvidia.com>
Signed-off-by: Jim Meyer <jimeyer@nvidia.com>
…ter edits

Signed-off-by: Jim Meyer <jimeyer@nvidia.com>
purp added 3 commits November 14, 2026 15:18
Label failures now say what is wrong with this PR's labels, and GitHub
API failures name the step that failed, such as requesting reviewers.

Signed-off-by: Jim Meyer <jimeyer@nvidia.com>
A label missing from REVIEWERS.md is treated as a wrong label on the PR,
so the message asks the author to replace it rather than edit the roster.

Signed-off-by: Jim Meyer <jimeyer@nvidia.com>
Signed-off-by: Jim Meyer <jimeyer@nvidia.com>
@purp purp added area:build CI/CD workflows, releases, build targets, packaging, and artifact publication. topic:dx Making OpenShell easy to contribute to for humans and agents. labels Nov 15, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:build CI/CD workflows, releases, build targets, packaging, and artifact publication. state:accepted A maintainer decided OpenShell should pursue this issue topic:dx Making OpenShell easy to contribute to for humans and agents.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(review): Review Readiness failures show no cause in the UI

1 participant