Skip to content

CNTRLPLANE-3853: Extract generic review-agent step registry from HyperShift#82096

Open
bryan-cox wants to merge 1 commit into
openshift:mainfrom
bryan-cox:CNTRLPLANE-3853
Open

CNTRLPLANE-3853: Extract generic review-agent step registry from HyperShift#82096
bryan-cox wants to merge 1 commit into
openshift:mainfrom
bryan-cox:CNTRLPLANE-3853

Conversation

@bryan-cox

@bryan-cox bryan-cox commented Jul 17, 2026

Copy link
Copy Markdown
Member

Summary

  • Extracts the hypershift/review-agent setup/process/report steps into a generic review-agent/ step registry that any OpenShift team can consume
  • Converts hypershift-review-agent workflow into a thin wrapper that sets two env vars (REVIEW_AGENT_FORK_REPO, REVIEW_AGENT_UPSTREAM_REPO) and delegates to the generic steps
  • Adds ONBOARDING.md with step-by-step instructions for new teams, including credential handling via thin ref YAML wrappers
  • Reuses jira-agent-github-app-auth pre step instead of duplicating token generation logic
  • Adds repo field to autodl telemetry schema for per-team filtering

Test plan

  • Verify hypershift-review-agent workflow still references the correct generic steps
  • Verify periodic-review-agent CI job triggers the refactored workflow
  • Confirm address-review-comments trigger job is untouched
  • Validate YAML syntax and step references resolve correctly
  • Rehearse periodic-review-agent job on this PR

CNTRLPLANE-3853

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Extracts HyperShift’s review-agent setup, processing, and reporting into reusable generic review-agent workflows and step references.
  • Updates HyperShift to act as a thin wrapper, supplying fork/upstream repositories while preserving Jira authentication and the address-review-comments trigger.
  • Generalizes repository cloning, GitHub App authentication, PR handling, report links, and telemetry, including the upstream repo field.
  • Adds onboarding documentation covering credentials, wrapper workflows, CI jobs, environment variables, and validation.
  • Removes obsolete HyperShift-specific setup/report references and updates ownership and metadata for the new shared step registry.

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

@bryan-cox, pj-rehearse: unable to determine affected jobs. This could be due to a branch that needs to be rebased. ERROR:

couldn't prepare candidate: couldn't checkout base SHA 6a1bc0aa43c841ee35694cf8c2a438f6f8eb8e04: error checking out "6a1bc0aa43c841ee35694cf8c2a438f6f8eb8e04": exit status 128 fatal: unable to read tree (6a1bc0aa43c841ee35694cf8c2a438f6f8eb8e04)

Interacting with pj-rehearse

Comment: /pj-rehearse to run up to 5 rehearsals
Comment: /pj-rehearse skip to opt-out of rehearsals
Comment: /pj-rehearse {test-name}, with each test separated by a space, to run one or more specific rehearsals
Comment: /pj-rehearse more to run up to 10 rehearsals
Comment: /pj-rehearse max to run up to 25 rehearsals
Comment: /pj-rehearse auto-ack to run up to 5 rehearsals, and add the rehearsals-ack label on success
Comment: /pj-rehearse list to get an up-to-date list of affected jobs
Comment: /pj-rehearse abort to abort all active rehearsals
Comment: /pj-rehearse network-access-allowed to allow rehearsals of tests that have the restrict_network_access field set to false. This must be executed by an openshift org member who is not the PR author

Once you are satisfied with the results of the rehearsals, comment: /pj-rehearse ack to unblock merge. When the rehearsals-ack label is present on your PR, merge will no longer be blocked by rehearsals.
If you would like the rehearsals-ack label removed, comment: /pj-rehearse reject to re-block merging.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

The change introduces a reusable generic review-agent workflow with configurable repositories, setup/process/report steps, onboarding documentation, and updated ownership metadata. HyperShift now delegates to these generic steps through a wrapper workflow and supplies repository-specific configuration.

Changes

Generic Review Agent

Layer / File(s) Summary
Workflow contracts and onboarding
ci-operator/step-registry/review-agent/...
Adds reusable setup, process, report, workflow, onboarding, metadata, and ownership definitions.
Repository-aware processing and reporting
ci-operator/step-registry/review-agent/process/..., ci-operator/step-registry/review-agent/report/...
Uses configured fork and upstream repositories for cloning, authentication, GitHub operations, telemetry, prompts, links, and HTML reports.
HyperShift wrapper adoption
ci-operator/step-registry/hypershift/review-agent/...
Updates HyperShift wiring and documentation to delegate to generic steps, configure repositories, and describe periodic and Gangway-triggered jobs.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant CIWorkflow
  participant ReviewAgentSetup
  participant ReviewAgentProcess
  participant GitHub
  participant ReviewAgentReport
  CIWorkflow->>ReviewAgentSetup: verify Claude Code CLI
  CIWorkflow->>ReviewAgentProcess: run repository-aware review
  ReviewAgentProcess->>GitHub: clone fork and query upstream pull request
  ReviewAgentProcess->>GitHub: address review comments and push changes
  CIWorkflow->>ReviewAgentReport: generate HTML report
  ReviewAgentReport->>GitHub: fetch pull request metadata
Loading

Suggested reviewers: celebdor, csrwng


Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error, 1 warning)

Check name Status Explanation Resolution
No-Sensitive-Data-In-Logs ❌ Error FAIL: review-agent-process-commands.sh embeds ${GITHUB_TOKEN_FORK} in a git config command without xtrace suppression, and tails raw Claude logs on failure. Wrap secret-bearing commands in set +x/set -x, and avoid dumping raw failure logs unless redacted or filtered for sensitive content.
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (13 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: extracting a generic review-agent step registry from HyperShift.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed PR changes are YAML/docs/scripts only; no Ginkgo test titles or dynamic test names were added or modified.
Test Structure And Quality ✅ Passed PASS — The PR only changes a workflow YAML, not Ginkgo test code, so the test-structure checklist is not applicable.
Microshift Test Compatibility ✅ Passed No new/modified Ginkgo test sources were added; the diff is step-registry YAML/docs/scripts only, so MicroShift compatibility is not applicable.
Single Node Openshift (Sno) Test Compatibility ✅ Passed PR changes are step-registry YAML/docs/scripts only; no new Ginkgo e2e tests or test files were added, so SNO test compatibility is not applicable.
Topology-Aware Scheduling Compatibility ✅ Passed Only a workflow env-var line was added; no manifests/controllers or topology-sensitive scheduling fields were introduced.
Ote Binary Stdout Contract ✅ Passed PASS: Diff only touches a YAML workflow wrapper, adding a target-PR env var; no Go/test binary code or process-level stdout writes were changed.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed No new Ginkgo e2e tests were added; the PR only changes workflow/step-registry YAML and shell scripts, so this compatibility check doesn’t apply.
No-Weak-Crypto ✅ Passed No weak-crypto algorithms, custom crypto, or token-secret comparisons appear in the changed review-agent files.
Container-Privileges ✅ Passed Only a workflow env var was added; no privileged, hostPID/Network/IPC, SYS_ADMIN, root, or allowPrivilegeEscalation settings appear in the changed manifest.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@openshift-ci
openshift-ci Bot requested review from celebdor and csrwng July 17, 2026 17:45
@openshift-ci

openshift-ci Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bryan-cox

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 17, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In
`@ci-operator/step-registry/review-agent/process/review-agent-process-commands.sh`:
- Around line 83-95: Update the missing-credentials branch in the review-agent
process command script to exit with a non-zero status after reporting
unavailable Vault secrets. Preserve the existing diagnostics and graceful
termination flow, but replace the successful exit so skipped review processing
marks the job as failed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: d7b2571d-2f06-4705-a248-85b8e2d18434

📥 Commits

Reviewing files that changed from the base of the PR and between 2c555b3 and 9c26b72.

📒 Files selected for processing (21)
  • ci-operator/step-registry/hypershift/review-agent/README.md
  • ci-operator/step-registry/hypershift/review-agent/hypershift-review-agent-workflow.metadata.json
  • ci-operator/step-registry/hypershift/review-agent/hypershift-review-agent-workflow.yaml
  • ci-operator/step-registry/hypershift/review-agent/process/hypershift-review-agent-process-ref.metadata.json
  • ci-operator/step-registry/hypershift/review-agent/report/hypershift-review-agent-report-ref.metadata.json
  • ci-operator/step-registry/hypershift/review-agent/report/hypershift-review-agent-report-ref.yaml
  • ci-operator/step-registry/hypershift/review-agent/setup/hypershift-review-agent-setup-ref.metadata.json
  • ci-operator/step-registry/hypershift/review-agent/setup/hypershift-review-agent-setup-ref.yaml
  • ci-operator/step-registry/review-agent/ONBOARDING.md
  • ci-operator/step-registry/review-agent/OWNERS
  • ci-operator/step-registry/review-agent/README.md
  • ci-operator/step-registry/review-agent/process/OWNERS
  • ci-operator/step-registry/review-agent/process/review-agent-process-commands.sh
  • ci-operator/step-registry/review-agent/process/review-agent-process-ref.yaml
  • ci-operator/step-registry/review-agent/report/OWNERS
  • ci-operator/step-registry/review-agent/report/review-agent-report-commands.sh
  • ci-operator/step-registry/review-agent/report/review-agent-report-ref.yaml
  • ci-operator/step-registry/review-agent/review-agent-workflow.yaml
  • ci-operator/step-registry/review-agent/setup/OWNERS
  • ci-operator/step-registry/review-agent/setup/review-agent-setup-commands.sh
  • ci-operator/step-registry/review-agent/setup/review-agent-setup-ref.yaml
💤 Files with no reviewable changes (6)
  • ci-operator/step-registry/hypershift/review-agent/setup/hypershift-review-agent-setup-ref.yaml
  • ci-operator/step-registry/hypershift/review-agent/report/hypershift-review-agent-report-ref.yaml
  • ci-operator/step-registry/hypershift/review-agent/setup/hypershift-review-agent-setup-ref.metadata.json
  • ci-operator/step-registry/hypershift/review-agent/report/hypershift-review-agent-report-ref.metadata.json
  • ci-operator/step-registry/hypershift/review-agent/hypershift-review-agent-workflow.metadata.json
  • ci-operator/step-registry/hypershift/review-agent/process/hypershift-review-agent-process-ref.metadata.json

Comment thread ci-operator/step-registry/review-agent/process/review-agent-process-commands.sh Outdated
@bryan-cox bryan-cox changed the title Extract generic review-agent step registry from HyperShift CNTRLPLANE-3853: Extract generic review-agent step registry from HyperShift Jul 17, 2026
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 17, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

@bryan-cox: This pull request references CNTRLPLANE-3853 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Summary

  • Extracts the hypershift/review-agent setup/process/report steps into a generic review-agent/ step registry that any OpenShift team can consume
  • Converts hypershift-review-agent workflow into a thin wrapper that sets two env vars (REVIEW_AGENT_FORK_REPO, REVIEW_AGENT_UPSTREAM_REPO) and delegates to the generic steps
  • Adds ONBOARDING.md with step-by-step instructions for new teams, including credential handling via thin ref YAML wrappers
  • Reuses jira-agent-github-app-auth pre step instead of duplicating token generation logic
  • Adds repo field to autodl telemetry schema for per-team filtering

Test plan

  • Verify hypershift-review-agent workflow still references the correct generic steps
  • Verify periodic-review-agent CI job triggers the refactored workflow
  • Confirm address-review-comments trigger job is untouched
  • Validate YAML syntax and step references resolve correctly
  • Rehearse periodic-review-agent job on this PR

CNTRLPLANE-3853

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Introduces a reusable, generic review-agent step registry in ci-operator/step-registry/review-agent (setup, process, report) so OpenShift teams can build thin wrapper workflows around shared logic.
  • Refactors ci-operator/step-registry/hypershift/review-agent/hypershift-review-agent-workflow.yaml into a wrapper that delegates to the generic step refs by chaining jira-agent-github-app-auth + review-agent-setup (pre), review-agent-process (test), and review-agent-report (post), while parameterizing fork/upstream via REVIEW_AGENT_FORK_REPO / REVIEW_AGENT_UPSTREAM_REPO.
  • Generalizes repo operations for cloning/pushing and PR lookup so the process/report steps work with arbitrary fork+upstream values; report generation now derives PR links/titles from REVIEW_AGENT_UPSTREAM_REPO and fails early if it’s unset.
  • Updates autodl telemetry to include the repo field (derived from REVIEW_AGENT_UPSTREAM_REPO) and adjusts associated report/link paths to match the generic step layout.
  • Adds onboarding documentation at ci-operator/step-registry/review-agent/ONBOARDING.md describing wrapper workflow creation, required Vault/GitHub App/credential handling via thin ref YAML wrappers, periodic vs presubmit triggering patterns, and guidance for validating generated Prow configuration.
  • Preserves the existing HyperShift address-review-comments trigger job behavior, including periodic execution being triggered through the Gangway-based periodic job wiring (rather than running inline).
  • Removes HyperShift-only step refs/command bindings that were superseded by the generic registry, and updates relevant step/metadata/OWNERS entries (including reviewer lists).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

1 similar comment
@openshift-ci-robot

openshift-ci-robot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

@bryan-cox: This pull request references CNTRLPLANE-3853 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Summary

  • Extracts the hypershift/review-agent setup/process/report steps into a generic review-agent/ step registry that any OpenShift team can consume
  • Converts hypershift-review-agent workflow into a thin wrapper that sets two env vars (REVIEW_AGENT_FORK_REPO, REVIEW_AGENT_UPSTREAM_REPO) and delegates to the generic steps
  • Adds ONBOARDING.md with step-by-step instructions for new teams, including credential handling via thin ref YAML wrappers
  • Reuses jira-agent-github-app-auth pre step instead of duplicating token generation logic
  • Adds repo field to autodl telemetry schema for per-team filtering

Test plan

  • Verify hypershift-review-agent workflow still references the correct generic steps
  • Verify periodic-review-agent CI job triggers the refactored workflow
  • Confirm address-review-comments trigger job is untouched
  • Validate YAML syntax and step references resolve correctly
  • Rehearse periodic-review-agent job on this PR

CNTRLPLANE-3853

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Introduces a reusable, generic review-agent step registry in ci-operator/step-registry/review-agent (setup, process, report) so OpenShift teams can build thin wrapper workflows around shared logic.
  • Refactors ci-operator/step-registry/hypershift/review-agent/hypershift-review-agent-workflow.yaml into a wrapper that delegates to the generic step refs by chaining jira-agent-github-app-auth + review-agent-setup (pre), review-agent-process (test), and review-agent-report (post), while parameterizing fork/upstream via REVIEW_AGENT_FORK_REPO / REVIEW_AGENT_UPSTREAM_REPO.
  • Generalizes repo operations for cloning/pushing and PR lookup so the process/report steps work with arbitrary fork+upstream values; report generation now derives PR links/titles from REVIEW_AGENT_UPSTREAM_REPO and fails early if it’s unset.
  • Updates autodl telemetry to include the repo field (derived from REVIEW_AGENT_UPSTREAM_REPO) and adjusts associated report/link paths to match the generic step layout.
  • Adds onboarding documentation at ci-operator/step-registry/review-agent/ONBOARDING.md describing wrapper workflow creation, required Vault/GitHub App/credential handling via thin ref YAML wrappers, periodic vs presubmit triggering patterns, and guidance for validating generated Prow configuration.
  • Preserves the existing HyperShift address-review-comments trigger job behavior, including periodic execution being triggered through the Gangway-based periodic job wiring (rather than running inline).
  • Removes HyperShift-only step refs/command bindings that were superseded by the generic registry, and updates relevant step/metadata/OWNERS entries (including reviewer lists).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@bryan-cox

Copy link
Copy Markdown
Member Author

/pj-rehearse periodic-ci-openshift-hypershift-main-periodic-review-agent

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

@bryan-cox: your /pj-rehearse request was not processed because the request waited in queue for longer than 5 minutes. Please retry in a few minutes.

@bryan-cox

Copy link
Copy Markdown
Member Author

/pj-rehearse periodic-ci-openshift-hypershift-main-periodic-review-agent

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

@bryan-cox: now processing your pj-rehearse request. Please allow up to 10 minutes for jobs to trigger or cancel.

@bryan-cox

Copy link
Copy Markdown
Member Author

/pj-rehearse periodic-ci-openshift-hypershift-main-periodic-review-agent

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

@bryan-cox: now processing your pj-rehearse request. Please allow up to 10 minutes for jobs to trigger or cancel.

@bryan-cox

Copy link
Copy Markdown
Member Author

/pj-rehearse periodic-ci-openshift-hypershift-main-periodic-review-agent

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

@bryan-cox: now processing your pj-rehearse request. Please allow up to 10 minutes for jobs to trigger or cancel.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@ci-operator/step-registry/review-agent/report/review-agent-report-ref.yaml`:
- Around line 15-18: Update the report step’s documentation description to state
that the script consumes artifacts produced by the review-agent processing step
and generates the HTML report from those artifacts, removing the inaccurate
claim that it directly parses Claude stream-json output.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: fbea7288-502d-4fa4-a8a7-142253522dcd

📥 Commits

Reviewing files that changed from the base of the PR and between c0c616f and 5521f5b.

📒 Files selected for processing (21)
  • ci-operator/step-registry/hypershift/review-agent/README.md
  • ci-operator/step-registry/hypershift/review-agent/hypershift-review-agent-workflow.yaml
  • ci-operator/step-registry/hypershift/review-agent/report/hypershift-review-agent-report-ref.yaml
  • ci-operator/step-registry/hypershift/review-agent/setup/hypershift-review-agent-setup-ref.yaml
  • ci-operator/step-registry/review-agent/ONBOARDING.md
  • ci-operator/step-registry/review-agent/OWNERS
  • ci-operator/step-registry/review-agent/README.md
  • ci-operator/step-registry/review-agent/process/OWNERS
  • ci-operator/step-registry/review-agent/process/review-agent-process-commands.sh
  • ci-operator/step-registry/review-agent/process/review-agent-process-ref.metadata.json
  • ci-operator/step-registry/review-agent/process/review-agent-process-ref.yaml
  • ci-operator/step-registry/review-agent/report/OWNERS
  • ci-operator/step-registry/review-agent/report/review-agent-report-commands.sh
  • ci-operator/step-registry/review-agent/report/review-agent-report-ref.metadata.json
  • ci-operator/step-registry/review-agent/report/review-agent-report-ref.yaml
  • ci-operator/step-registry/review-agent/review-agent-workflow.metadata.json
  • ci-operator/step-registry/review-agent/review-agent-workflow.yaml
  • ci-operator/step-registry/review-agent/setup/OWNERS
  • ci-operator/step-registry/review-agent/setup/review-agent-setup-commands.sh
  • ci-operator/step-registry/review-agent/setup/review-agent-setup-ref.metadata.json
  • ci-operator/step-registry/review-agent/setup/review-agent-setup-ref.yaml
💤 Files with no reviewable changes (5)
  • ci-operator/step-registry/review-agent/report/OWNERS
  • ci-operator/step-registry/review-agent/OWNERS
  • ci-operator/step-registry/hypershift/review-agent/report/hypershift-review-agent-report-ref.yaml
  • ci-operator/step-registry/hypershift/review-agent/setup/hypershift-review-agent-setup-ref.yaml
  • ci-operator/step-registry/review-agent/process/OWNERS
🚧 Files skipped from review as they are similar to previous changes (15)
  • ci-operator/step-registry/review-agent/setup/review-agent-setup-ref.metadata.json
  • ci-operator/step-registry/review-agent/setup/review-agent-setup-commands.sh
  • ci-operator/step-registry/review-agent/process/review-agent-process-ref.metadata.json
  • ci-operator/step-registry/review-agent/setup/OWNERS
  • ci-operator/step-registry/review-agent/review-agent-workflow.yaml
  • ci-operator/step-registry/review-agent/review-agent-workflow.metadata.json
  • ci-operator/step-registry/review-agent/process/review-agent-process-ref.yaml
  • ci-operator/step-registry/hypershift/review-agent/hypershift-review-agent-workflow.yaml
  • ci-operator/step-registry/review-agent/ONBOARDING.md
  • ci-operator/step-registry/review-agent/report/review-agent-report-commands.sh
  • ci-operator/step-registry/review-agent/report/review-agent-report-ref.metadata.json
  • ci-operator/step-registry/review-agent/setup/review-agent-setup-ref.yaml
  • ci-operator/step-registry/review-agent/README.md
  • ci-operator/step-registry/hypershift/review-agent/README.md
  • ci-operator/step-registry/review-agent/process/review-agent-process-commands.sh

Comment on lines +15 to +18
documentation: |-
Generates an HTML report from the review-agent processing output.
Parses stream-json output from Claude and produces a readable report
in ${ARTIFACT_DIR} with token usage, cost estimates, tool calls, and errors.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Correct the report-step description.

The report script consumes artifacts extracted by the processing step; it does not parse Claude stream-json directly. Update the documentation to describe the actual contract.

Proposed wording
 documentation: |-
   Generates an HTML report from the review-agent processing output.
-  Parses stream-json output from Claude and produces a readable report
+  Consumes extracted review-agent artifacts and produces a readable report
   in ${ARTIFACT_DIR} with token usage, cost estimates, tool calls, and errors.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
documentation: |-
Generates an HTML report from the review-agent processing output.
Parses stream-json output from Claude and produces a readable report
in ${ARTIFACT_DIR} with token usage, cost estimates, tool calls, and errors.
documentation: |-
Generates an HTML report from the review-agent processing output.
Consumes extracted review-agent artifacts and produces a readable report
in ${ARTIFACT_DIR} with token usage, cost estimates, tool calls, and errors.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ci-operator/step-registry/review-agent/report/review-agent-report-ref.yaml`
around lines 15 - 18, Update the report step’s documentation description to
state that the script consumes artifacts produced by the review-agent processing
step and generates the HTML report from those artifacts, removing the inaccurate
claim that it directly parses Claude stream-json output.

Extract the hypershift/review-agent setup/process/report steps into a
generic review-agent/ step registry that any OpenShift team can consume
by creating a thin wrapper workflow with two env vars.

CNTRLPLANE-3853

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@bryan-cox
bryan-cox force-pushed the CNTRLPLANE-3853 branch 2 times, most recently from d41d06b to 21fff61 Compare July 20, 2026 16:22
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

[REHEARSALNOTIFIER]
@bryan-cox: the pj-rehearse plugin accommodates running rehearsal tests for the changes in this PR. Expand 'Interacting with pj-rehearse' for usage details. The following rehearsable tests have been affected by this change:

Test name Repo Type Reason
periodic-ci-openshift-hypershift-main-periodic-review-agent N/A periodic Registry content changed
Interacting with pj-rehearse

Comment: /pj-rehearse to run up to 5 rehearsals
Comment: /pj-rehearse skip to opt-out of rehearsals
Comment: /pj-rehearse {test-name}, with each test separated by a space, to run one or more specific rehearsals
Comment: /pj-rehearse more to run up to 10 rehearsals
Comment: /pj-rehearse max to run up to 25 rehearsals
Comment: /pj-rehearse auto-ack to run up to 5 rehearsals, and add the rehearsals-ack label on success
Comment: /pj-rehearse list to get an up-to-date list of affected jobs
Comment: /pj-rehearse abort to abort all active rehearsals
Comment: /pj-rehearse network-access-allowed to allow rehearsals of tests that have the restrict_network_access field set to false. This must be executed by an openshift org member who is not the PR author

Once you are satisfied with the results of the rehearsals, comment: /pj-rehearse ack to unblock merge. When the rehearsals-ack label is present on your PR, merge will no longer be blocked by rehearsals.
If you would like the rehearsals-ack label removed, comment: /pj-rehearse reject to re-block merging.

@openshift-ci

openshift-ci Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

@bryan-cox: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@bryan-cox

Copy link
Copy Markdown
Member Author

/pj-rehearse ack

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

@bryan-cox: now processing your pj-rehearse request. Please allow up to 10 minutes for jobs to trigger or cancel.

@openshift-merge-bot openshift-merge-bot Bot added the rehearsals-ack Signifies that rehearsal jobs have been acknowledged label Jul 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. rehearsals-ack Signifies that rehearsal jobs have been acknowledged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants