HYPERFLEET-930 - docs: replace CLAUDE.md with AGENTS.md#53
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR adds comprehensive development conventions documentation to the HyperFleet API Spec repository and enhances the CI workflow to intelligently gate version checks. AGENTS.md introduces rules for API spec verification, version bumping, TypeSpec authoring, shared-vs-core architecture boundaries, and operational constraints. CLAUDE.md is refactored to reference AGENTS.md instead of duplicating guidance. The CI workflow now detects changes to TypeSpec contract files (\*.tsp) between the pull request base and head, and conditionally executes the version bump check only when contracts have changed, skipping the check and logging a message when no contract changes are detected. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 @.github/workflows/ci.yml:
- Around line 45-50: The CI step uses BASE_REF and relies on git cat-file -e
"$BASE_REF" but in shallow clones (actions/checkout@v6 default fetch-depth:1)
that SHA is absent so the script sets changed=true incorrectly; update the check
to fetch the missing base commit before falling back (e.g., attempt git fetch
origin "$BASE_REF" --depth=1 or change checkout to fetch full history) and then
re-run git cat-file -e and git diff --name-only "$BASE_REF" HEAD -- '*.tsp' so
the contract-change detection only triggers when the actual base commit is
present; modify the logic around BASE_REF, git cat-file -e and CHANGED to
perform the fetch-first fallback.
🪄 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: 55564d9f-e54d-4a0a-b815-312f004d3a89
📒 Files selected for processing (2)
.github/workflows/ci.ymlAGENTS.md
There was a problem hiding this comment.
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 @.github/workflows/ci.yml:
- Around line 16-24: The workflow uses mutable refs for GitHub Actions; replace
actions/checkout@v6 and actions/setup-node@v6 with their corresponding immutable
40-character commit SHAs (e.g., actions/checkout@<sha>,
actions/setup-node@<sha>) so the CI uses fixed action versions; also update the
similar softprops/action-gh-release@v2 reference in
.github/workflows/release.yml to its commit SHA. Locate the two uses: the "uses:
actions/checkout@v6" and "uses: actions/setup-node@v6" entries in ci.yml (and
the softprops/action-gh-release@v2 entry in release.yml) and substitute the
mutable tags with the exact commit SHAs from the corresponding action
repositories.
🪄 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: 3490fd34-8f77-486b-95fc-5bd22c4e947d
📒 Files selected for processing (1)
.github/workflows/ci.yml
There was a problem hiding this comment.
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 `@core/models/cluster/model.tsp`:
- Line 5: Remove the stray test artifact line ("* test") from
core/models/cluster/model.tsp; locate the added line in model.tsp (the literal
"* test") and delete it so the file matches production schema, then run the
repo's pre-commit/CI lint/schema checks to ensure no contract-change is
triggered and do not modify main.tsp, schemas, or CHANGELOG for this removal.
🪄 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: 61c9fd16-b628-4ac3-936e-d33da5a5b34c
📒 Files selected for processing (1)
core/models/cluster/model.tsp
1 participant
Summary
Test Plan
make test-allpassesmake lintpassesmake test-helm(if applicable)