Download the PHP package ondrejmirtes/backward-compatibility-check without Composer
On this page you can find all versions of the php package ondrejmirtes/backward-compatibility-check. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ondrejmirtes/backward-compatibility-check
More information about ondrejmirtes/backward-compatibility-check
Files in ondrejmirtes/backward-compatibility-check
Package backward-compatibility-check
Short Description Tool to compare two revisions of a public API to check for BC breaks
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package backward-compatibility-check
Roave Backward Compatibility Check
A tool that can be used to verify BC breaks between two versions of a PHP library.
This fork changes internal classes and methods interpretation according to PHPStan backward compatibility promise.
Pre-requisites/assumptions
- Your project uses
git - Your project uses
composer.jsonto define its dependencies - All source paths are covered by an
"autoload"section incomposer.json - Changes need to be committed to
gitto be covered. You can implement your own logic to extract sources and dependencies from a project though.
Installation
Usage
Adding to a continuous integration pipeline
The typical intended usage is to just add roave-backward-compatibility-check
to your CI build:
This will automatically detect the last minor version tagged, and
compare the API against the current HEAD. If any BC breaks are found,
the tool returns a non-zero status, which on most CI systems will cause
the build to fail.
NOTE: detecting the base version only works if you have git tags in
the SemVer-compliant x.y.z format, such as 1.2.3.
NOTE: since this tool relies on tags, you need to make sure tags are fetched
as part of your CI pipeline. For example in a GitHub action, note the use of
fetch-depth: 0:
Running manually
To generate additional documentation for changelogs:
GitHub Actions
When running in GitHub Actions, it is endorsed to use the --format=github-actions output format:
Documentation
If you need further guidance:
Configuration
There are currently no configuration options available.
All versions of backward-compatibility-check with dependencies
ext-json Version *
azjezz/psl Version ^2.0.4
composer/composer Version ^2.4.2
nikolaposa/version Version ^4.1.0
ocramius/package-versions Version ^2.5.1
ondrejmirtes/better-reflection Version ^6.3.0
symfony/console Version ^6.1.5