README

Controls semantic versioning of your Laravel application with easy!

The main goal of this package is to add automated and independent semantic version control, without the need to use git tags or branches.

Installation

You can install the package via composer:

composer require codimais/appver

After installing the package in your project, go to the terminal and run the below command to initialize AppVer:

php artisan appver:init

The command will ask if you want to define a specific initial version. You can accept the default, which is "1.0.0" or type yours app version.

It will also try to identify if your project has a git repository and, if so, it will offer to create a git hook to automate the version increment.

Usage

Auto increment

If your project has a git repository and if AppVer was able to create the pre-commit hook, you don't need to do anything.

Before each commit, git will run the pre-commit hook that will increment the version of your application and add it to the current commit, automatically.

Manual increment

If your project is not in a git repository or if you do not want to use auto increment, then you can increment the version of your application manually:

// To increment the patch number:
php artisan appver:inc --patch
// Output: Version changed from '1.0.0' to '1.0.1'

// To increment the minor version number:
php artisan appver:inc --minor
// Output: Version changed from '1.0.0' to '1.1.0'

// To increment the major version number:
php artisan appver:inc --major
// Output: Version changed from '1.0.0' to '2.0.0'

You can combine the increments as you need. The order does not matter.

php artisan appver:inc --patch --minor
// Output: Version changed from '1.0.0' to '1.1.1'

php artisan appver:inc --major --minor
// Output: Version changed from '1.0.0' to '2.1.0'

php artisan appver:inc --minor --major --patch
// Output: Version changed from '1.0.0' to '2.1.1'

If you need to display the current version in your API or in a View:

<?php
 
namespace App\Http\Controllers;
 
use Codimais\AppVer\AppVer;
 
class MyController extends Controller
{
    /**
     * Show something
     */
    public function show(): View
    {
        $appver = new AppVer();

        return view('my.view', [
            'app_version' => $appver->get()
        ]);
    }
}

Testing

Testing are not ready yet!

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email lantonello@gmail.com instead of using the issue tracker.

codimais / appver

Maintainers

Details