Download the PHP package leviy/release-tool without Composer
On this page you can find all versions of the php package leviy/release-tool. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download leviy/release-tool
More information about leviy/release-tool
Files in leviy/release-tool
Package release-tool
Short Description Command line tool for releasing new versions of a project
License MIT
Informations about the package release-tool
Release Tool
Inspired by Liip RMT, this release tool helps you to automate the release of new versions of your software. It is written in PHP but can be used for any type of project, as long as you have PHP installed on your machine.
Features
- Determines the next version number based on semantic versioning
- Creates an annotated Git tag and pushes it to the remote repository
- Creates a GitHub release with the name of the release and a changelog with changes since the previous version
- Supports pre-release (alpha/beta/rc) versions
Installation
Phar (recommended)
The recommended method of installing this package is using a phar file. This is because installing using Composer can possibly cause dependency conflicts. You can download the most recent phar from the Github Releases page.
Global installation (linux)
Move the downloaded release-tool.phar
file into your PATH (e.g. ~/bin/release-tool
). Make sure to set the file to executable permissions (e.g. chmod 775 release-tool
).
Composer
Alternatively, you can install this package using Composer:
Configuration
GitHub personal access token
This tool requires a personal access token with repo
scope to create GitHub
releases. Create one here
and store it in .release-tool/auth.yml
in your home folder (~
on Linux, user
folder on Windows):
Usage
Note: these usage instructions assume that you have downloaded the
release-tool.phar
file to your project directory. If you have installed it in a different location, update the commands accordingly. If you have installed the tool as a Composer dependency, usevendor/bin/release
instead.
Releasing a new version
Use to release a version. For example:
This will release version 1.0.0. By default, this will create a prefixed,
annotated Git tag, in this case v1.0.0
.
Automatically generating a version number
After tagging a first version, you can let the tool calculate the new version number for you based on the current version and a number of questions. To do so, omit the version from the previous command:
Pre-release versions
If you want to create a pre-release (alpha/beta/rc) version, run:
Other commands
Run to see a list of available commands.
Updating the release tool
The following command will update the release tool to the latest version:
All versions of release-tool with dependencies
beberlei/assert Version ^3.2
consolidation/self-update Version ^2.0
guzzlehttp/guzzle Version ^6.3
symfony/config Version ^5.0
symfony/console Version ^5.0
symfony/dependency-injection Version ^5.0
symfony/yaml Version ^5.0