fix(ci): exclude openapi.json version from spec verification#434
Conversation
openapi.json is generated — its version comes from package.json at generation time. Release-please was reformatting the entire file instead of surgically updating the version field. Instead, exclude info.version from the CI spec verification so release PRs pass without needing release-please to touch the generated file. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Entire-Checkpoint: 478f466a481d
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughModified CI workflow and release configuration to decouple OpenAPI schema version tracking from schema equality checks. The CI verification step now ignores Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Release PreviewNo version bumps detected. All changes are in unversioned paths or use exempt commit types. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #434 +/- ##
==========================================
+ Coverage 62.32% 71.80% +9.48%
==========================================
Files 135 114 -21
Lines 10085 7168 -2917
Branches 1053 1051 -2
==========================================
- Hits 6285 5147 -1138
+ Misses 3583 1804 -1779
Partials 217 217
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR updates the release + CI automation to stop treating the generated OpenAPI spec’s version as a “meaningful diff”, unblocking release PRs where the spec’s version is expected to change.
Changes:
- Removes
packages/api-client’sopenapi.jsonfrom release-pleaseextra-filesto avoid large, noisy rewrites. - Updates the CI “Verify API Spec & Client” step to ignore
openapi.json’sinfo.versionwhen comparing committed vs generated specs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
release-please-config.json |
Removes openapi.json from release-please’s version bump targets for @cipherbox/api-client. |
.github/workflows/ci.yml |
Adjusts semantic OpenAPI comparison to exclude info.version before diffing. |
Summary
openapi.jsonfrom release-pleaseextra-files— it was reformatting the entire file (+564 -150) instead of surgically updating the versioninfo.versionfrom the CI semantic comparison since it's dynamic frompackage.jsonat generation timeThis unblocks the release PR (#430) which was failing the "Verify API Spec & Client" check.
🤖 Generated with Claude Code
Summary by CodeRabbit