/composer-release-plugin

:ship: A composer plugin to help making releases.

Primary LanguagePHPMIT LicenseMIT

Build Status Scrutinizer Code Quality Latest Stable Version Latest Unstable Version License

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
        }
    }
}