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.
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:
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
and php composer.phar install
in the newly cloned directory.See the example section for examples of how to use the tool.
Buildingphp-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.
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:
name: Continuous integration on: [push] jobs: build: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v2 with: fetch-depth: 0 - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php }} tools: composer:v2 coverage: xdebug # Your own CI configuration goes here - name: Evaluate semantic versioning run: | wget https://psvcg.coreteks.org/php-semver-checker-git.phar php php-semver-checker-git.phar suggest -vvv --include-before=src --include-after=src --details --allow-detached
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:
allow-detached: true details: true include-before: src include-after: src
With this configuration file, you can update the configuration file created previously:
Before:
# Your own CI configuration goes here - name: Evaluate semantic versioning run: | wget https://psvcg.coreteks.org/php-semver-checker-git.phar php php-semver-checker-git.phar suggest -vvv --include-before=src --include-after=src --details --allow-detached
After:
# Your own CI configuration goes here - name: Evaluate semantic versioning run: | wget https://psvcg.coreteks.org/php-semver-checker-git.phar php php-semver-checker-git.phar suggest -vvvCompare two commits (without semantic versioning)
# arguments are: before-commit/branch/tag after-commit/branch/tag php bin/php-semver-checker-git compare v1.6.4 v2.0.0 --include-before=src --include-after=srcCompare HEAD against your latest semantic version tag
php bin/php-semver-checker-git suggest --allow-detached --include-before=src --include-after=src
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.
php bin/php-semver-checker-git suggest --allow-detached --include-before=src --include-after=src --tag=~5.0
Note: --tag
supports any semantic versioning constraint such as <
, <=
, >=
, '>', ~x.y.z
, ^x.y.z
x.y.*
.
The code is licensed under the MIT license. See LICENSE.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4