axion-release-plugin

Additional

Language
Groovy
Version
N/A
Created
Sep 16, 2014
Updated
May 21, 2018
Owner
Allegro Tech (allegro)
Contributors
lgawin
Frieder Bluemle (friederbluemle)
szpak
tschulte
adamdubiel
vbuell
erichsend
martinda
bgalek
dbottstein
gschueler
levsa
rzukow
uglyfigurine
vi4m
piotrchowaniec
ProTrent
MarkEWaite
Show all (21)21
Activity
Badge
Generate
Download
Source code

Advertising

axion-release-plugin

gradle release and version management plugin

Releasing versions in Gradle is very different from releasing in Maven. Maven came with maven-release-plugin which did all the dirty work. Gradle has no such tool and probably doesn't need it anyway. Evolution of software craft came to the point, when we start thinking about SCM as ultimate source of truth about project version. Version should not be hardcoded in pom.xml or build.gradle.

axion-release-plugin embraces this philosophy. Instead of reading project version from buildfile, it is derived from nearest tag in SCM (or set to default if nothing was tagged). If current commit is tagged commit, project has a release version. If there were any commits after last tag, project is in SNAPSHOT version. This very simple and intuitive philosophy, alongside with Semantic Versioning rules, makes it a lot easier to manage project versions along SCM tag versions.

Basic usage

plugins {
    id 'pl.allegro.tech.build.axion-release' version '1.9.1'
}

project.version = scmVersion.version
$ git tag
<empty list>

$ ./gradlew currentVersion
0.1.0-SNAPSHOT

$ ./gradlew release

$ git tag
release-0.1.0

$ ./gradlew cV
0.1.0

$ git add -A && git commit -m "Updates something" && ./gradlew release

$ git tag
release-0.1.0
release-0.1.1

$ ./gradlew cV
0.1.1

Documentation

Documentation is available at axion-release read the docs.

License

axion-release-plugin is published under Apache License 2.0.