Download the PHP package pragmarx/version without Composer
On this page you can find all versions of the php package pragmarx/version. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pragmarx/version
More information about pragmarx/version
Files in pragmarx/version
Package version
Short Description Take control over your Laravel app version
License MIT
Informations about the package version
Version
Take control over your Laravel app version
Description
This package is a Laravel (5.5+) utility which helps you keep and manage your application version, increment version numbers (major, minor, patch, commit), and can also use your last commit hash.
The end results of this package are:
- Print a version on a page.
- Print it in the console, via an Artisan command.
Full SemVer compatibility
This package is able to parse a SemVer version:
And translate it to be used as:
You can use the format function to rewrite and show it in your app, for instance, as:
Some use cases for those results could be:
- 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!
Features
Easily control you app version using a YAML config file
Use your git commit as your app commit hash/number
Configure it
And you may have an output like this
Or just use an incremental commit hash/number:
To get
Easily increment your version numbers, using Artisan commands
Which should print the new version number
Available for all of them:
The output format is highly configurable
You can configure the :
Those are the results for full
and compact
formats
It gives you access to dynamic methods:
And should you create a new one:
It will also become callable:
A Facade is available
Instantiating it
If you prefer not to use the Façade:
The best ways to instantiate it are:
A simple PHP object instantiation:
Or to get an already instantiated Version object from the container:
But you have to make sure you published the config file
A Blade directive is also ready to be used in your views
You can use this directive to render a full version format:
Or choose the format:
You can configure the directive name:
Then
Git tags
You can use your git tags as application versions, all you need is to set the version source to "git":
And if you add a commit hash/number to your tags:
Version will use it as your app commit hash/number
Matching other version (git tags) formats
You probably only need to change the git version matcher
So let's say you tag your releases as
You can change your matcher to
And remove dots from your formats:
Using the current application version in your code
Here's a community example on how to send the app version number when logging an exception to Bugsnag:
Commit Timestamp
This package also lets you absorb the last commit timestamp or store the current date to the version.yml file. This is the format in the config file:
To absorb you only need to configure mode: absorb
then execute:
php artisan version:absorb
But you can also set mode: increment
then execute:
To store the current date and time to the config file:
And you can then use it to show in your app:
Artisan commands
Those are the commands you have at your disposal:
version:show
Show the current app version:
version:absorb
You need to set mode: absorb
.
Version can absorb git version and commit to the config file, so you can delete the .git folder and still keep your version and commit for fast access. You have to configure git_absorb
in your config file:
And run it
The usual configuration setup to implement absorb is:
version:(major|minor|patch|commit)
You need to set mode: increment
.
Increment the version item:
Regex Matcher
This is the current regex used to break a version string:
`
You can test it online: https://regex101.com/r/Ly7O1x/42
Install
Via Composer
Then publish the configuration file you'll have to:
And you should be good to use it in your views:
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
:
[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.
If you are using Git commits on your commit numbers, you may have to add the git repository to your .env file
If you are using git-local
make sure the current folder is a git repository
Minimum requirements
- Laravel 5.5
- PHP 7.0
Testing
Troubleshooting
- 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:
Author
License
This package is licensed under the MIT License - see the LICENSE
file for details
Contributing
Pull requests and issues are welcome.
All versions of version with dependencies
laravel/framework Version >=5.5.33
pragmarx/yaml Version ^1.0
symfony/process Version ^3.3|^4.0|^5.0|^6.0