ci: gate breaking spec changes with oasdiff; fix sdk_generation trigger - #128
Merged
Merged
Conversation
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
✅ No breaking changes in the latest revision. |
LukasParke
force-pushed
the
fix/spec-lint-errors
branch
from
August 13, 2026 01:29
b842372 to
7fccf6e
Compare
LukasParke
force-pushed
the
ci/pr-validation
branch
from
August 13, 2026 01:30
fce5878 to
63028ef
Compare
- Add breaking-changes.yml: oasdiff compares the PR spec against the base branch and fails on breaking changes (fail-on WARN). PRs labeled 'breaking-change' still get the report but pass, acknowledging an intentional break. Complements validate.yml, which covers static lint but not client compatibility. - Fix sdk_generation.yaml paths filter: './plex-api-spec.yaml' never matched (GitHub path globs are repo-root-relative without './'), so spec pushes did not trigger SDK generation; masked by the hourly cron.
LukasParke
force-pushed
the
ci/pr-validation
branch
from
August 13, 2026 01:32
63028ef to
99096ae
Compare
LukasParke
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rebuilt after #117 landed. The original version of this PR added Redocly lint gating, a warning baseline, and prettier decisions — all now superseded by
validate.yml(Redocly + Speakeasy + vacuum + prettier + Arazzo lint). What upstream still lacks is exactly what remains here. Stacked on #127; auto-retargets tomainwhen it merges.What changed
New workflow:
breaking-changes.ymloasdiff compares the PR's spec against the base branch and fails on changes that would break existing API clients — and therefore the eight generated SDKs.
validate.ymlcovers static correctness but says nothing about client compatibility; this closes that gap.fail-on: WARN(strict: definite and potentially-breaking changes both fail)breaking-change: the report is still produced and posted, but the job passespersist-credentials: false, concurrency group, paths filtermediaQueryde-duplication in fix: remove duplicate parameters, fix invalid patterns and examples #127: with duplicate query keys present, oasdiff's parameter matching is nondeterministic and reports phantom breaking changes on identical specs (verified: 3× self-diff clean after the fix)Fix:
sdk_generation.yamlpaths filter./plex-api-spec.yamlnever matched anything (GitHub Actions path globs are repo-root-relative without./), so spec pushes did not actually trigger SDK generation — masked by the hourly cron.