blumilksoftware / version
Blumilk versioning package
v1.0.2
2024-09-23 05:46 UTC
Requires
- php: ^8.3
- symfony/process: v7.0.7
Requires (Dev)
- blumilksoftware/codestyle: ^v3.0.0
- phpunit/phpunit: ^11.0.9
This package is auto-updated.
Last update: 2024-11-01 06:04:36 UTC
README
blumilksoftware/version
A versioning based on git for all Blumilk projects. If Git is not available, it falls back to the timestamp.
Usage
Add package to the project:
composer require blumilksoftware/version
Then use the Version
class to generate version strings based on Git or timestamp:
<?php declare(strict_types=1); use Blumilk\Version\Version; $version = (new Version())->generate();
Configuration
You can configure the Version
class to generate long version strings:
<?php declare(strict_types=1); use Blumilk\Version\Version; $version = (new Version(true))->generate();
Helper class
You can use also the VersionHelper
class to generate version strings:
<?php declare(strict_types=1); use Blumilk\Version\VersionHelper; $shortVersion = VersionHelper::generateShortVersion(); $longVersion = VersionHelper::generateLongVersion();
Contributing
In a cloned or forked repository, run:
composer install
There are scripts available for package codestyle checking and testing:
There is also the Docker Compose configuration available:
docker compose up -d docker compose exec php php -v docker compose exec php composer -v
There are also Makefile commands available:
make run
make shell
make test
make csf
make stop
Please maintain our project guidelines:
- keep issues well described, labeled and in English,
- add the issue number to all your commits,
- add the issue number to your branch name,
- squash your commits into one commit with a standardized name.