ci(sdks): Warn against non-trivial changes to multiple SDKs#17397
ci(sdks): Warn against non-trivial changes to multiple SDKs#17397szokeasaurusrex wants to merge 3 commits intomasterfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
szokeasaurusrex
force-pushed
the
szokeasaurusrex/single-sdk-change-enforcement
branch
from
2c40441 to
5f181b9
Compare
szokeasaurusrex
force-pushed
the
szokeasaurusrex/single-sdk-change-enforcement
branch
from
5f181b9 to
23f7ea8
Compare
Add a CI job which fails and posts a comment when non-trivial changes to multiple SDK docs pages are detected. We define non-trivial as affecting more than five lines. We do not intend to make this CI job required; rather, I hope PR authors and reviewers will heed the comments posted by this workflow.
szokeasaurusrex
force-pushed
the
szokeasaurusrex/single-sdk-change-enforcement
branch
from
23f7ea8 to
51b9566
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Change the filter condition from >= to > so that SDKs with exactly
LINE_THRESHOLD (5) changed lines are not treated as non-trivial.
This aligns the code with the documented behavior stating changes
must 'exceed' the threshold ('more than five lines').
Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Daniel Szoke <szokeasaurusrex@users.noreply.github.com>
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 6d2cb4d. Configure here.
| } | ||
| if (segs[0] === 'platform-includes') { | ||
| return segs.at(-1)!.split('.')[0]; | ||
| } |
There was a problem hiding this comment.
Non-SDK files misclassified as SDK names cause false positives
Low Severity
The sdkForPath function doesn't filter out non-SDK files, causing them to be counted as separate "SDKs." For platform-includes, files like _default.mdx (which exists in platform-includes/capture-error/) return _default as the SDK name. For docs/platforms, the file index.mdx returns index.mdx as the SDK name. If any of these non-SDK files accumulate >5 changed lines alongside a real SDK, the check produces a false-positive violation, which could erode trust in the advisory CI job.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit 6d2cb4d. Configure here.
2 participants
Add a CI job which fails and posts a comment when non-trivial changes to multiple SDK docs pages are detected. We define non-trivial as affecting more than five lines.
We do not intend to make this CI job required; rather, I hope PR authors and reviewers will heed the comments posted by this workflow.
Example runs: The job fails against #17398 and passes against #17400.