Skip to content

fix(ci): exclude openapi.json version from spec verification#434

Merged
FSM1 merged 1 commit into
mainfrom
fix/openapi-version-check
Apr 1, 2026
Merged

fix(ci): exclude openapi.json version from spec verification#434
FSM1 merged 1 commit into
mainfrom
fix/openapi-version-check

Conversation

@FSM1

@FSM1 FSM1 commented Apr 1, 2026

Copy link
Copy Markdown
Owner

Summary

  • Remove openapi.json from release-please extra-files — it was reformatting the entire file (+564 -150) instead of surgically updating the version
  • Exclude info.version from the CI semantic comparison since it's dynamic from package.json at generation time

This unblocks the release PR (#430) which was failing the "Verify API Spec & Client" check.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Refined API specification verification in the CI workflow to improve consistency between committed and generated specification files.
    • Simplified API client package release configuration by adjusting version synchronization settings.

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
Copilot AI review requested due to automatic review settings April 1, 2026 04:28
@coderabbitai

coderabbitai Bot commented Apr 1, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 852858ed-8345-4a4b-b390-f3842075d796

📥 Commits

Reviewing files that changed from the base of the PR and between e8cfe13 and 5aa6e63.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml
  • release-please-config.json

Walkthrough

Modified CI workflow and release configuration to decouple OpenAPI schema version tracking from schema equality checks. The CI verification step now ignores info.version differences when comparing generated API specs, while the release configuration removes the extra-files entry that previously synchronized openapi.json version with package releases.

Changes

Cohort / File(s) Summary
CI workflow verification
.github/workflows/ci.yml
Modified "Verify no uncommitted changes to generated files" step to strip info.version from packages/api-client/openapi.json before JSON comparison, allowing schema updates without triggering validation failures on version-only changes.
Release configuration
release-please-config.json
Removed extra-files entry for packages/api-client/openapi.json that previously tied $.info.version to release versioning, decoupling OpenAPI version from package version management.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

release:cipherbox-sdk:fix

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: excluding the openapi.json version field from CI specification verification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/openapi-version-check

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.

❤️ Share

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

@FSM1 FSM1 enabled auto-merge (squash) April 1, 2026 04:29
@github-actions

github-actions Bot commented Apr 1, 2026

Copy link
Copy Markdown
Contributor

Release Preview

No version bumps detected. All changes are in unversioned paths or use exempt commit types.

@codecov

codecov Bot commented Apr 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.80%. Comparing base (e8c4ef3) to head (5aa6e63).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            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              
Flag Coverage Δ
api 84.91% <ø> (-0.06%) ⬇️
api-client 84.91% <ø> (-0.06%) ⬇️
core 84.91% <ø> (-0.06%) ⬇️
crypto 84.91% <ø> (-0.06%) ⬇️
desktop 14.40% <ø> (-16.82%) ⬇️
sdk 84.91% <ø> (-0.06%) ⬇️
sdk-core 84.91% <ø> (-0.06%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 35 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI 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.

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’s openapi.json from release-please extra-files to avoid large, noisy rewrites.
  • Updates the CI “Verify API Spec & Client” step to ignore openapi.json’s info.version when 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.

Comment thread .github/workflows/ci.yml
@FSM1 FSM1 merged commit 4471b1b into main Apr 1, 2026
31 checks passed
This was referenced Apr 1, 2026
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.

2 participants