- What does a release do?
- How to specify my own version number scheme?
- How to specify my own tag name and commit message?
Now that we built and tested our awesome software, let’s tell the world and release it.
Each buildfile can specify the current version with a constant named
What does a release do?
The default behavior of the
Release task is the following:
- Check that the version to be released and the next version are different
- Check that the project is being tracked by Git or Subversion
- Package, test and deploy the artifacts using
THIS_VERSIONvalue minus the
-SNAPSHOTsuffix (if any)
- Tag the repository with the released version number
- Update the value of
THIS_VERSIONin the buildfile with the next version number
Buildr will increment the last digit of the 3-digit versioni number if
THIS_VERSION ends with
So, at the end of a release, the buildfile now looks like this:
And the Git repository now contains two new commits and a new tag.
How to specify my own version number scheme?
THIS_VERSION does not contain
-SNAPSHOT, Buildr delegates the resolution of the next version number to the user which has 2 differents ways to express her wishes:
Release.next_version or the environment variable
Release class can receive the next version of the buildfile. This could be a string or a proc that would receive the current version and return the next version.
Using the environment variable NEXT_VERSION
If the environment variable
NEXT_VERSION is set, Buildr will use this value to update
THIS_VERSION at the end of the release.
For conveniency, this variable is case insensitive.
So, all 3 following commands will run a release with a custom new version:
Those commands will generate the Buildfile below:
The environment variable
NEXT_VERSION has precedence over Release.next_version.
Using an alternate version file
To avoid dealing with conflicts over the Buildfile, you can store the version inside version.rb next to it.
Your Buildfile should import version.rb like so:
How to specify my own tag name and commit message?
As explained earlier, Buildr will create two new commits and a new tag in the version control system. Similarly to
Release.next_version, the commit message and the tag name can be customized with
Release.tag_name. Both could be strings or procs that would receive the released version