A new major version is released each year on the first Friday of February. Major versions make incompatible API changes and remove or hard-deprecate (see below) features.
A new minor version is released on the first Friday of April, June, August, October, and December. Minor versions add functionality in a backward compatible manner. Minor versions may soft-deprecate (see below) features.
Patch versions are released as needed to address issues in a backward compatible manner.
The backward compatibility promise for PHPUnit has the following exceptions:
PHPUnit's units of code that are annotated with
are not covered by the backward compatibility promise for PHPUnit.
These units of code are internal to PHPUnit and are subject to change or removal even in minor or patch versions. They must not be used in third-party code: not in test code and not in extensions for PHPUnit or in wrappers around PHPUnit.
PHPUnit's units of code that are not annotated with
are annotated with
@no-named-arguments instead. This documents
the fact that parameter names are not covered by the backward compatibility
promise for PHPUnit.
For value objects that are passed from PHPUnit's event system to subscribers, only the public methods for querying information are covered by the backward compatibility promise for PHPUnit. For instance, the constructor methods of these objects are not covered.
Since there is no point in extending these classes outside of PHPUnit's own code,
abstract class of such a value object
for example, is not considered to be a break of backward compatibility.
The sunsetting of features follows the following steps:
If the feature is used through a unit of code, for instance by calling a
method, then the
@deprecated annotation is added to that unit
of code. IDEs and static analysis tools can now report that deprecated
functionality is used.
Tests that use a soft-deprecated assertion method, for example, will continue to work in exactly the same way.
The feature is hard-deprecated in the next major version after it was soft-deprecated.
Tests that use a hard-deprecated assertion method, for example, will continue to work in exactly the same way. The only difference is that PHPUnit now reports that a hard-deprecated feature is used.
The feature is removed in the next major version after it was hard-deprecated.
Tests that use an assertion method that was removed, for example, will no longer work.
In very rare cases we may delete a tag in order to unpublish a broken release. The new release that fixes what was broken will always have a different tag than the one that was unpublished.