NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist
Packagist, #1957 most downloaded on Packagist
Tool to compare two revisions of a public API to check for BC breaks
Latest stable
8.27.0
Last release 26 days ago
26 Oct 2026
Ships fairly regularly
a new release about every 2 months
Nearly every release is documented
notes for 57 of 57 stable releases
Nothing withdrawn
no release was ever pulled
8 years old
57 releases · first in 2018
Drag across the ruler to compare, or tap a release to open it.
Total pull requests resolved: 4
Feature release (minor)
readonly as a BC break thanks to @NopeCharonfinal as a BC break thanks to @NopeCharonprotected constant in final class -> private is not a BC break thanks to @NopeCharonTotal pull requests resolved: 2
Feature release (minor)
final method in an open class is not a BC break thanks to @NopeCharon and @vjikYour coding agent can read these notes before it upgrades. Set up the MCP server →
Total pull requests resolved: 1
Feature release (minor)
Traversable types are contravariant to iterable thanks to @NopeCharon and @vjikTotal pull requests resolved: 2
Feature release (minor)
#[\NoDiscard] to a method as a BC break thanks to @NopeCharon and @OcramiusTotal pull requests resolved: 1
Feature release (minor)
Total pull requests resolved: 7
Feature release (minor)
Total pull requests resolved: 1
Feature release (minor)
Total pull requests resolved: 1
Feature release (minor)
Total pull requests resolved: 1
Feature release (minor)
Total pull requests resolved: 5
Feature release (minor)
protected method in final class -> private is not a BC break thanks to @acoultonTotal pull requests resolved: 1
Feature release (minor)
Total pull requests resolved: 4
Feature release (minor)
Total pull requests resolved: 8
Feature release (minor)
azjezz/psl to ^4.0.1 thanks to @renovate[bot]Total pull requests resolved: 1
Feature release (minor)
Total pull requests resolved: 1
Feature release (minor)
Total pull requests resolved: 3
Feature release (minor)
Total pull requests resolved: 2
Feature release (minor)
Total pull requests resolved: 3
Feature release (minor)
JsonFormatter thanks to @NyholmTotal pull requests resolved: 1
Feature release (minor)
Total pull requests resolved: 4
Feature release (minor)
Total pull requests resolved: 5
Feature release (minor)
Total pull requests resolved: 1
Feature release (minor)
ORGANIZATION_ADMIN_TOKEN to tag + release thanks to @OcramiusTotal pull requests resolved: 2
Feature release (minor)
Total pull requests resolved: 2
Feature release (minor)
Total pull requests resolved: 4
Feature release (minor)
Total pull requests resolved: 1
8.2.x bugfix release (patch)
@internal methods of final classes thanks to @Ocramius and @weirdanTotal pull requests resolved: 6
Feature release (minor)
PropertyTypeChanged report thanks to @jack-wormanTotal pull requests resolved: 1
Feature release (minor)
Backwards incompatible release (major)
Backwards incompatible release (major)
This release changes the base REF from which BC breaks are computed: it was X.Y.0 before, and it is now X.Y.Z (considers also Z).
To do so, we moved some classes around:
Class Roave\BackwardCompatibility\Git\PickLastMinorVersionFromCollection has been deleted
Total pull requests resolved: 3
Feature release (minor)
Total pull requests resolved: 3
Feature release (minor)
Total pull requests resolved: 2
Feature release (minor)
azjezz/psl:^2 thanks to @OcramiusTotal pull requests resolved: 7
Feature release (minor)
Backwards incompatible release (major)
Backwards incompatible release (major)
Due to BC breaks in symfony/console:^6, some incompatible changes were introduced:
The parameter $definition of Symfony\Component\Console\Command\Command#setDefinition() changed from no type to a non-contravariant array|Symfony\Component\Console\Input\InputDefinition
The parameter $default of Symfony\Component\Console\Command\Command#addArgument() changed from no type to a non-contravariant mixed|null
The parameter $shortcut of Symfony\Component\Console\Command\Command#addOption() changed from no type to a non-contravariant string|array
The parameter $default of Symfony\Component\Console\Command\Command#addOption() changed from no type to a non-contravariant mixed|null
Total pull requests resolved: 10
Feature release (minor)
Total pull requests resolved: 2
Feature release (minor)
__DIR__ and __FILE__ by changing the base path of LocatedSource instances, prevent false-positive BC breaks on those magic constants thanks to @Ocramius and @mimmi20Total pull requests resolved: 41
Feature release (minor)
Total pull requests resolved: 1
6.1.x bugfix release (patch)
Total pull requests resolved: 7
Feature release (minor)
@no-named-arguments on the class phpdoc block thanks to @asgrimTotal pull requests resolved: 1
6.0.x bugfix release (patch)
Merry Christmas! :christmas_tree: :santa:
roave/backward-compatibility-check 6.0.0Merry Christmas! :christmas_tree: :santa:
This release of roave/backward-compatibility-check brings some major features:
php:~8.0.12 and php:~8.1.0 supportcomposer/composer:^2.2.1 support@no-named-arguments.--format=github-actions output format, for better integration with GitHub Actions--install-development-dependencies, to also include your require-dev in autoload definitions,
during analysis.vimeo/psalmroave/infection-static-analysis-pluginThis release includes multiple changes to bring it up-to-date with the latest capabilities
from roave/better-reflection:5.0.0.
In order to upgrade to the latest and greatest of each library, some internals of this library have changed radically.
If you were using the library as a CLI tool only, you only need to worry about these new checks, which may affect your build automation:
If you were extending/customizing this library, chances are that you may need to perform major adjustments,
in order to reach compatibility with 6.0.0.
__invoke() thanks to @OcramiustotallyTyped="true" in psalm configuration thanks to @Ocramiusthecodingmachine/safe, webmozart/assert, and symfony/process by azjezz/psl thanks to @azjezzcomposer/composer:^2 thanks to @Legion112require-dev dependencies when analyzing a codebase thanks to @Nyholmroave/better-reflection:^5.0.0, now that it is released thanks to @Ocramius"Continuous Integration" workflow thanks to @Ocramiusroave/better-reflection:^5 thanks to @Ocramius--install-development-dependencies thanks to @asgrimat() matcher with onConsecutive() in mock/spy methods thanks to @weirdantotallyTyped="true" with psalm thanks to @OcramiusTotal pull requests resolved: 21
Release 5.0.0
PropertyRemoved should only operate on public properties for final classes thanks to @Ocramiusbeberlei/assert with webmozart/assert, upgrade CS ruleset thanks to @Ocramiusnikolaposa/version dependency to 4.0.0 thanks to @OcramiusTotal pull requests resolved: 1
Release 4.4.0
Total pull requests resolved: 2
Release 4.3.0
Total pull requests resolved: 7
Release 4.2.1
deploy.api_key.secure/deploy.api_key thanks to @OcramiusTotal pull requests resolved: 4
Release 4.2.0
This release adds the reported version of this tool to its STDERR output.
This release adds the reported version of this tool to its STDERR output.
Total issues resolved: 11
This release excludes @internal marked symbols from BC checks.
This release excludes @internal marked symbols from BC checks.
Dependencies have been updated, and testing/static-analysis have been hugely improved.
Complex types such as @var Foo<T1, T2> also no longer cause the tool to crash during inspection.
Total issues resolved: 20
@api and @internal thanks to @OcramiusVersionsCollection::first() instead iterator_to_array()[0] thanks to @andrew-demb@internal symbols thanks to @OcramiusFqsen expressions for documented property types thanks to @OcramiusA new backwards incompatibility check was also introduced (and enabled by default), inspecting whether an ancestor of a symbol was introduced or remov…
This release improves the architecture for scanning of source and dependency files,
leading to a 100x speed improvement when dealing with larger codebases, such as
doctrine/orm or doctrine/dbal.
A new backwards incompatibility check was also introduced (and enabled by default), inspecting whether an ancestor of a symbol was introduced or removed.
Total issues resolved: 8
Changes instance to internally use generators for better "on the fly" results thanks to @OcramiusDirectoriesSourceLocator is extremely slow, since all AST symbols are traversed to look for existing classes thanks to @OcramiusThis release fixes an issue with pre-releases (alpha/beta/rc) being considered for stability checks, and introduces documentation for the github actio
This release fixes an issue with pre-releases (alpha/beta/rc) being considered for stability checks, and introduces documentation for the github actions provided by @Nyholm.
Total issues resolved: 4
PickLastMinorVersionFromCollection thanks to @schmunk42deprecates Roave\BackwardCompatibility\Factory\DirectoryReflectorFactory
This new major release due to some backwards-incompatible changes in some signatures and parameters of the CLI tooling. This release:
composer.jsonsources-path CLI argumentRoave\BackwardCompatibility\Command\AssertBackwardsCompatibleRoave\BackwardCompatibility\Factory\DirectoryReflectorFactoryThis is the full list of statically detected BC breaks:
[BC] CHANGED: The parameter $reflectorFactory of Roave\BackwardCompatibility\Command\AssertBackwardsCompatible#__construct() changed from Roave\BackwardCompatibility\Factory\DirectoryReflectorFactory to a non-contravariant Roave\BackwardCompatibility\Factory\ComposerInstallationReflectorFactory
Total issues resolved: 2
composer.json "autoload" section analysis thanks to @OcramiusThis release fixes an issue in which removed classes were not detected as such, but rather detected as classes that were changed to interfaces due to
This release fixes an issue in which removed classes were not detected as such, but rather detected as classes that were changed to interfaces due to internall fallback symbol stubbing mechanisms.
Total issues resolved: 3
phpstan.neon to phpstan.neon.dist for easier overrides thanks to @OcramiusStubClassSourceLocator from default setup thanks to @OcramiusThis release improves the reliability of the library by marking crashes as "SKIPPED" BC checks. Skipped checks still count as backwards-incompatible c
This release improves the reliability of the library by marking crashes as "SKIPPED" BC checks. Skipped checks still count as backwards-incompatible changes for now, so the tool will exit with a non-zero status code in case a crash occurred.
Starting from this release, a PHAR distribution of the package will be available for each new release under https://github.com/Roave/BackwardCompatibilityCheck/releases.
We also improved the autoloading of the library, with the clear pre-condition that it
must either be installed via composer require or as an application via composer create-project
or git clone + `composer install.
The test automation has also been hardened by introducing both PSALM and PHPStan static analysis checks.
Total issues resolved: 9
Throwable-safe wrappers around all Roave\BackwardCompatibility\DetectChanges\BCBreak\* classes that may crash during reflection operations thanks to @Ocramiuscomposer require, composer create-project or git clone + composer install thanks to @OcramiusThis release fixes a few mistakes in the handling of --from. Specifically:
This release fixes a few mistakes in the handling of --from. Specifically:
--from will now lead to --from to default to the lowest latest minor release--from is now permitted again (bug introduced in 1.0.2)Total issues resolved: 1
This release fixes the omission of the --from flag in the CLI interface, which was defaulting to the incorrect '' (empty string).
This release fixes the omission of the --from flag in the CLI interface,
which was defaulting to the incorrect '' (empty string).
Also, classes that were previously not found are now stubbed out as interfaces without inheritance nor methods, which allows scanning for BC breaks in packages with optional dependencies.
Total issues resolved: 5
Roave\BetterReflection\Reflection\ReflectionClass "XXX" could not be found in the located source thanks to @bendaviesThis release fixes an autoloading issue when the project is required as a composer dependency rather than being installed standalone.
This release fixes an autoloading issue when the project is required as a composer dependency rather than being installed standalone.
Total issues resolved: 3
vendor/autoload.php locations to support in-project-dev-dependency installations thanks to @OcramiusThis is the first public release of roave/backward-compatibility-check.
This is the first public release of roave/backward-compatibility-check.
From this release on, this library follows strict semantic versioning, with each release that introduces a new backwards compatibility break (BC) being a new major version.
Total issues resolved: 40
from version (use default last tag) thanks to @asgrimbin/api-compare script in the CI build thanks to @asgrimComparator thanks to @asgrimfinal in combination with protected to exclude some code analysis scenarios thanks to @Ocramiusroave/security-advisories to require-dev thanks to @Ocramius"autoload": {"files": [...\} is not used, correct composer usage thanks to @Ocramiusroave/backward-compatibility-check thanks to @Ocramiusmaster because from/to revisions are the same thanks to @asgrimOne column per quarter.