This package is a Laravel (5.5+) utility which helps you keep and manage your application version, increment version numbers (major, minor, patch, build), and can also use your last commit hash as build number.
- Print a version on a page.
- Print it in the console, via an Artisan command.
- Make sure a rollback was successful.
- Know if an update reached all servers.
- Check if a user is looking at the last version of your app.
- Verify if is Travis CI testing the version it is supposed to be testing.
- You simple love to version your stuff, and you like to see them in all your pages? That's cool too. :)
- What's your use case? Tell us!
version:
current:
major: 1
minor: 0
patch: 0
format: '{$major}.{$minor}.{$patch}'
build:
mode: number
number: 701036
Configure it
build:
mode: git-local
And you may have an output like this
MyApp version 1.0.0 (build a9c03f)
Or just use an incremental build number:
build:
mode: number
number: 701036
To get
MyApp version 1.0.0 (build 701036)
php artisan version:build
Which should print the new version number
New build: 701037
MyApp version 1.0.0 (build 701037)
Available for all of them:
php artisan version:major
php artisan version:minor
php artisan version:patch
php artisan version:build
You can configure the :
format:
version: "{$major}.{$minor}.{$patch}"
full: "version {{'format.version'}} (build {$build})"
compact: "v{{'format.version'}}-{$build}"
Those are the results for full
and compact
formats
MyApp version 1.0.0 (build 701037)
MyApp v1.0.0-701037
It gives you access to dynamic methods:
Version::compact()
And should you create a new one:
format:
awesome: "awesome version {$major}.{$minor}.{$patch}"
It will also become callable:
Version::awesome()
Version::version() // 1.2.25
Version::build() // 703110
Version::major() // 1
Version::minor() // 2
Version::patch() // 25
Version::format('full') // version 1.0.0 (build 703110)
Version::full() // version 1.0.0 (build 703110) -- dynamic method
Version::format('compact') // v.1.0.0-703110
Version::compact() // v.1.0.0-703110 -- dynamic method
If you prefer not to use the Façade:
dd(
Version::format()
);
The best ways to instantiate it are:
A simple PHP object instantiation:
$version = new \PragmaRX\Version\Package\Version();
dd(
$version->format()
);
Or to get an already instantiated Version object from the container:
dd(
app(\PragmaRX\Version\Package\Version::class)->format()
);
But you have to make sure you published the config file
You can use this directive to render a full version format:
@version
Or choose the format:
@version('full')
@version('compact')
You can configure the directive name:
blade_directive: printversion
Then
@printversion('compact')
You can use your git tags as application versions, all you need is to set the version source to "git":
version_source: git
And if you add a build number to your tags:
git tag -a -f v0.1.1.3128
Version will use it as your app build number
You probably only need to change the git version matcher
git:
...
version:
matcher: "/[V|v]*[ersion]*\\s*\\.*(\\d+)\\.(\\d+)\\.(\\d+)\\.*(\\w*)/"
So let's say you tag your releases as
2017120299
YYYYMMDD##
You can change your matcher to
git:
version:
matcher: "/(\d{4})(\d{2})(\d{2})(?:\d{2})/"
And remove dots from your formats:
format:
compact: "v{$major}{$minor}{$patch}-{$build}"
Those are the commands you have at your disposal:
Show the current app version:
> php artisan version:show
> PragmaRX version 1.0.0 (build 701031)
> php artisan version:show --format=compact
> PragmaRX v1.0.0-701031
> php artisan version:show --format=compact --suppress-app-name
> v1.0.0-701031
Increment the version item:
$ php artisan version:minor
New minor version: 5
MyApp version 1.5.0 (build 701045)
Clear cache and refresh versions
> a version:refresh
> Version was refreshed.
> PragmaRX version 1.0.0 (build 4f76c)
Version can absorb git version and build to the config file, so you can delete the .git folder and still keep your version and build cached for fast access. You have to configure git_absorb
in your config file:
build:
#...
git_absorb: git-local # "false", "git-local" or "git-remote"
And run it
php artisan version:absorb
The usual configuration setup to implement absorb is:
version_source: config ## must be set as config
current:
major: 1 ## |
minor: 0 ## | --> will be changed by absorb
patch: 0 ## |
git_absorb: git-local ## configure to get from local or remote
build:
mode: number ## must be set as number
number: f477c8 ## will be changed by absorb
git_absorb: git-local ## configure to get from local or remote
Via Composer
composer require pragmarx/version
Then publish the configuration file you'll have to:
php artisan vendor:publish --provider="PragmaRX\Version\Package\ServiceProvider"
And you should be good to use it in your views:
@version
As git versions are cached, you can tell composer to refresh your version numbers every time an update or install occur, by adding the refresh command to post-autoload-dump
:
"post-autoload-dump": [
...
"@php artisan version:refresh"
]
[Optional] You may also can automated this process by set inside your .git/hooks/post-commit
. It will automatic run the command once you have make a commit.
#!/bin/sh
php artisan version:refresh
If you are using Git commits on your build numbers, you may have to add the git repository to your .env file
VERSION_GIT_REMOTE_REPOSITORY=https://github.com/antonioribeiro/version.git
If you are using git-local
make sure the current folder is a git repository
- Laravel 5.5
- PHP 7.0
$ composer test
- If you are having trouble to install because of symfony/router (3.3/3.4) or symfony/yaml (3.3/3.4), you can try to:
rm -rf vendor
rm composer.lock
composer install
This package is licensed under the MIT License - see the LICENSE
file for details
Pull requests and issues are welcome.