egabor/composer-release-plugin

Bump version number and make a release of git based SemVer projects with ease.

dev-master / 1.0.x-dev 2018-09-21 16:57 UTC

Requires

• php: ^5.5.9|^7.0.8
• composer-plugin-api: ^1.1

Requires (Dev)

• composer/composer: ^1.6
• roave/security-advisories: dev-master
• symfony/phpunit-bridge: ^3.4
• symfony/process: ^3.4

MIT

• Gábor Egyed

README

Composer Release Plugin

A composer plugin to help making releases.

Pre-requisites/assumptions

• Your project uses git

Installation

composer require --dev egabor/composer-release-plugin

Usage

After installation a new release command should appear in the list of available commands.

Documentation

If you need more information about the command and how to use it, you should read:

composer release --help

Configuration

There are some configuration options:

use-prefix: use 'v' to prefix the release version number (default: true)
release-branch: name of the branch where the releases originated from (default: master)

These options can be set in the project's composer.json file, under the extra.egabor-release key, like:

{
    "name": "vendor/package",
    "require-dev": {
        "egabor/composer-release-plugin": "^1.0"
    },
    "extra": {
        "egabor-release": {
            "release-branch": "release",
            "use-prefix": false
        }
    }
}