Download the PHP package tomzx/php-semver-checker-git without Composer
On this page you can find all versions of the php package tomzx/php-semver-checker-git. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tomzx/php-semver-checker-git
More information about tomzx/php-semver-checker-git
Files in tomzx/php-semver-checker-git
Package php-semver-checker-git
Short Description PHP Semantic Versioning Checker for GIT
License MIT
Homepage https://github.com/tomzx/php-semver-checker-git
Informations about the package php-semver-checker-git
PHP Semantic Versioning Checker for git
PHP Semantic Versioning Checker for git
is a console/library which allows you to inspect a set of before and after source code using GIT.
The command line utility will use an existing git
repository to compare to changesets using anything git checkout
would accept (sha1, branch, tag). It will checkout in detached
mode in order not to pollute your list of branches.
Note It is strongly suggested you do not run this directly on any repository you do not want to lose. Make a copy of it beforehand and run php-semver-checker-git
on that copy instead.
Getting started
As this is still an alpha package, it is not suggested to include php-semver-checker-git
directly in your composer.json. There are however a couple ways to use the tool:
- Preferred method Download the latest .phar build. Note that the .phar build is generally less bleeding edge than the following methods.
php composer.phar create-project tomzx/php-semver-checker-git --stability=dev
will clone to a new php-semver-checker-git folder in your current working directorygit clone https://github.com/tomzx/php-semver-checker-git.git
andphp composer.phar install
in the newly cloned directory.
See the example section for examples of how to use the tool.
Building php-semver-checker-git.phar
First, make sure you have box installed. Then, in the base directory, you can run the following command which will generate the php-semver-checker-git.phar
file.
Using php-semver-checker-git
with GitHub actions
It is very easy to add php-semver-checker-git
to your build process and to get a nice report you can check in the GitHub actions
logs.
In a file under .github/workflows/
, add the following:
In order to simplify the above call to php-semver-checker-git
, we suggest you create a php-semver-checker-git.yml
configuration file at the root of your project. In it, you can put the following:
With this configuration file, you can update the configuration file created previously:
Before:
After:
Example
Compare two commits (without semantic versioning)
Compare HEAD against your latest semantic version tag
Note: --allow-detached
is very useful when you are running this command on GitHub actions
or any other continuous integration provider. It is necessary when a checkout is done on a particular commit, which makes HEAD
become detached
. If this option is not passed to the command, it will abort. This is done because it is impossible to revert the original detached
branch when the suggest
command completes.
Compare HEAD against a specific tag constraint
Note: --tag
supports any semantic versioning constraint such as <
, <=
, >=
, '>', ~x.y.z
, ^x.y.z
x.y.*
.
License
The code is licensed under the MIT license. See LICENSE.
All versions of php-semver-checker-git with dependencies
klaussilveira/gitter Version dev-php-semver-checker
symfony/console Version ^4.4|^5.1
tomzx/php-semver-checker Version ^0.15.1
vierbergenlars/php-semver Version ^3.0.2