Skip to content

HYPERFLEET-930 - docs: rewrite CLAUDE.md as AGENTS.md#42

Open
kuudori wants to merge 3 commits into
openshift-hyperfleet:mainfrom
kuudori:HYPERFLEET-930
Open

HYPERFLEET-930 - docs: rewrite CLAUDE.md as AGENTS.md#42
kuudori wants to merge 3 commits into
openshift-hyperfleet:mainfrom
kuudori:HYPERFLEET-930

Conversation

@kuudori
Copy link
Copy Markdown

@kuudori kuudori commented May 26, 2026

Summary

  • HYPERFLEET-930

Test Plan

  • Unit tests added/updated
  • make test-all passes
  • make lint passes
  • Helm chart changes validated with make test-helm (if applicable)
  • Deployed to a development cluster and verified (if Helm/config changes)
  • E2E tests passed (if cross-component or major changes)

kuudori added 2 commits May 26, 2026 14:02
Audit and rewrite agent instructions. CLAUDE.md now imports
AGENTS.md. Fixes incorrect defaults (REGISTRY, IMAGE_TAG),
wrong validation command, removes redundant sections, adds
verified gotchas and source-of-truth table.
Add .pre-commit-config.yaml with hyperfleet-commitlint hook
matching sentinel/api/adapter repos. Add install-hooks and
fmt Makefile targets.
@openshift-ci openshift-ci Bot requested review from rafabene and rh-amarin May 26, 2026 20:13
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 26, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign vkareh for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 92a13259-76f1-4cb3-b918-c8cbb54320cf

📥 Commits

Reviewing files that changed from the base of the PR and between 4b60809 and ea1c620.

📒 Files selected for processing (1)
  • Makefile

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Added a comprehensive guide for infrastructure development and deployment flows.
    • Simplified documentation references to point to the new guide.
  • Chores

    • Configured pre-commit hooks to enforce commit message standards automatically.
    • Added Makefile targets to install hooks and format Terraform; improved validation to accommodate alternative message broker setups.

Walkthrough

This PR establishes a complete developer environment setup for the HyperFleet infrastructure repository. It introduces AGENTS.md as a comprehensive guide covering the Terraform-to-GKE/Pub/Sub pipeline, Helm deployment flow, Makefile conventions, and operational gotchas. The existing CLAUDE.md is replaced with a single reference to this new guide. Two new Make targets are added: install-hooks for pre-commit hook installation and fmt for recursive Terraform formatting. A .pre-commit-config.yaml file is created to register the hyperfleet-commitlint hook for the commit-msg stage from the hyperfleet-hooks repository at version v0.2.1.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main documentation changes: rewriting CLAUDE.md as AGENTS.md. It is concise, specific, and directly describes the primary changeset objective.
Description check ✅ Passed The description references the Jira ticket (HYPERFLEET-930) and includes a test plan checklist, which is related to the changeset. However, it lacks specific details about the actual changes being made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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 `@Makefile`:
- Around line 452-454: Update the Makefile so the install-hooks target depends
on a new check-pre-commit prerequisite: add "check-pre-commit" as a prerequisite
of install-hooks and implement a check-pre-commit target that verifies the
external tool "pre-commit" is available (e.g., using a shell check like command
-v pre-commit and failing with a clear message if missing). Reference the
Makefile target names install-hooks and check-pre-commit when making the change.
🪄 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: Central YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 70d2e303-728a-4a46-b3c9-f586bbb3a8df

📥 Commits

Reviewing files that changed from the base of the PR and between 4053441 and 4b60809.

📒 Files selected for processing (4)
  • .pre-commit-config.yaml
  • AGENTS.md
  • CLAUDE.md
  • Makefile

Comment thread Makefile
…dation

Adapter chart v2.0.0 requires broker.rabbitmq.{url,queue,exchange,routingKey}
when broker type is rabbitmq. ci-dry-run validates both broker types but
never passed these fields for adapters, breaking helm template rendering.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant