Repository navigation
Add a Roave backward compatibility check - #134
Merged
Merged
Conversation
There was a problem hiding this comment.
Ship it.
- Local verification covers v3.0.0..v3.1.0 (baseline reduces noise to the four GithubOAuth changes) and v3.1.0..HEAD (clean).
- Workflow skips on first release and on major bumps, as documented.
- Baseline and export-ignore are correctly scoped; no changes to package API are suppressed.
Owner
Author
Quality Gate: successAll quality checks passed. Quality Check Results All tools passed without violations. |
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
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.
Adds a GitHub Actions workflow that runs roave/backward-compatibility-check (MIT) to catch public API changes before they ship.
When it runs
vX.Y.Ztag.v*tag pushes: compares the new tag against the previous release tag. A new major version is skipped, since breaking changes are expected there.How it is installed
The tool is installed with
composer global requireinto a job-localCOMPOSER_HOMEunder the runner temp dir, socomposer.jsonis unchanged. That job-local config also setsaudit.block-insecureto false so older tagged releases can install their pinned dependencies for the comparison. Nothing else in the repo uses that setting.Baseline
.roave-backward-compatibility-check.xmlignores only changes reported on the Symfony and Laravel console base classes that the package commands extend (getDefaultName()/getDefaultDescription()removed upstream, andconfigure()/initialize()/interact()gaining avoidreturn type). The file is export-ignored in.gitattributesso it stays out of the dist archive.Changes to the package's own API are still reported. For example, comparing v3.0.0 to v3.1.0 goes from 9 reported changes to these 4:
GithubOAuth::$clientId,$clientSecretand$redirectUrlchanged fromstringto?stringGithubOAuth::getAuthorizationUrl()gained a$stateparameterChecked locally