Skip to content

fix(ci): scope API client drift check to generated paths only#310

Merged
FSM1 merged 1 commit into
mainfrom
fix/ci-api-client-diff-scope
Mar 22, 2026
Merged

fix(ci): scope API client drift check to generated paths only#310
FSM1 merged 1 commit into
mainfrom
fix/ci-api-client-diff-scope

Conversation

@FSM1

@FSM1 FSM1 commented Mar 22, 2026

Copy link
Copy Markdown
Owner

Summary

  • The CI drift check was diffing the entire packages/api-client/ directory, which would false-positive on hand-written changes to instance.ts, tests, or package.json
  • Narrowed to only check openapi.json, src/generated/, and src/models/ — the actual generated outputs

Test plan

  • CI passes

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Enhanced internal CI verification process for generated file consistency to ensure build integrity.

The diff check was comparing the entire packages/api-client/ directory,
which would false-positive on changes to instance.ts, tests, or
package.json. Narrow to openapi.json, src/generated/, and src/models/.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Entire-Checkpoint: b38a549badbc
@coderabbitai

coderabbitai Bot commented Mar 22, 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: f282c4af-fac6-4b65-a267-aa93e2cbe2c7

📥 Commits

Reviewing files that changed from the base of the PR and between 374c880 and 742e967.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml

Walkthrough

Updated CI workflow step to broaden the scope of generated file verification, explicitly including packages/api-client/openapi.json, packages/api-client/src/generated/, and packages/api-client/src/models/ instead of checking the entire directory.

Changes

Cohort / File(s) Summary
CI Workflow Configuration
.github/workflows/ci.yml
Expanded generated file verification in the api-spec job's "Verify no uncommitted changes to generated files" step to explicitly check specific paths using a multi-line shell command passed to git diff --exit-code.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

🚥 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 clearly and specifically describes the main change: scoping the CI drift check to only generated paths, which matches the core objective of narrowing the diff scope from the entire packages/api-client/ directory to only generated files.
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/ci-api-client-diff-scope

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) March 22, 2026 02:39
@FSM1 FSM1 merged commit f78a87d into main Mar 22, 2026
24 checks passed
@codecov

codecov Bot commented Mar 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 50.28%. Comparing base (374c880) to head (742e967).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #310      +/-   ##
==========================================
- Coverage   50.36%   50.28%   -0.08%     
==========================================
  Files         114      115       +1     
  Lines        9162     9854     +692     
  Branches      716      716              
==========================================
+ Hits         4614     4955     +341     
- Misses       4371     4722     +351     
  Partials      177      177              
Flag Coverage Δ
api 82.76% <ø> (ø)
api-client 82.76% <ø> (ø)
core 82.76% <ø> (ø)
crypto 82.76% <ø> (ø)
desktop 28.64% <ø> (+2.73%) ⬆️
sdk 82.76% <ø> (ø)
sdk-core 82.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 10 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.

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