We have a workflow requirement that essentially mean that we need to have the artifact version of a module externally defined from the current branch in git.
I.e. if
Indeed, Maven can't change the version of it's own project in one run with other goals. On top of it, as far as I know, Maven doesn't support arbitrary properties in the <version>
tag. Therefore, a separate execution is required to run a goal which will change the version of the POM. There are various plugins which can do it - for this case one might use the versions:set
goal from versions
plugin - http://mojo.codehaus.org/versions-maven-plugin/set-mojo.html
So, one might execute it as follows for example:
mvn versions:set -DgenerateBackupPoms=false -DnewVersion=$branch-SNAPSHOT
where the $branch
variable has to contain current Git branch name; it can be extracted with git rev-parse
, like this:
branch=$(git rev-parse --abbrev-ref HEAD)
But still, one needs to execute it somehow. You can do manually, but it is cumbersome. So, my guess is that indeed the most robust solution would be to approach this from Git side. That is - a Git hook. Here is the complete Git post-checkout
hook which will do the job (same code as above with some filtering to run the hook only when the branch is checked out, not the individual files only):
#!/bin/bash
echo 'Will change the version in pom.xml files...'
# check if the checkout was to checkout a branch
if [ $3 != '1' ]
then echo 'git checkout did not checkout a branch - quitting';exit
fi
# get current branch name
branch=$(git rev-parse --abbrev-ref HEAD)
version=$branch-SNAPSHOT
# run maven versions plugin to set new version
mvn versions:set -DgenerateBackupPoms=false -DnewVersion=$version
echo 'Changed version in pom.xml files to $version'
Put this content to the file PROJECTDIR\.git\hooks\post-checkout
file. Note that the hook file should be executable to run it (chmod +x post-checkout
).
Few notes about versions
plugin - it is pretty flexible and supports many options and have few other goals which might be of help, depending on your project structure (do you use parent poms or not, do childs have their own versions or do they derive from parent, etc.). So, the hook above might be modified slightly to support you specific case by using other goals from versions
plugin or by specifying additional parameters.
Pros:
Cons:
UPDATE
Hereafter is the more complicated version of the hook, which will not only set the version to the branch name, but will also preserve the suffix of the old version. For example, provided old version master-1.0-SNAPSHOT
, switching to feature1
branch will change the version of the project to feature1-1.0-SNAPSHOT
. This bash script suffers from few problems (requires branch names without dash symbol (-
) in the name, and only takes the version of the root pom), but may give an idea of how the hook may be extended: given a mix of mvn and bash commands you can extract and update quite a lot of the information in the POM.
#!/bin/bash
echo 'Will change the version in pom.xml files...'
# check if the checkout was to checkout a branch
if [ $3 != '1' ]
then echo 'git checkout did not checkout a branch - quitting';exit
fi
# get current branch name
branch=$(git rev-parse --abbrev-ref HEAD)
# get current version of the top level pom
current_version=$(mvn help:evaluate -Dexpression=project.version | grep -v '\[.*')
# extract version suffix
suffix=$(echo $current_version | cut -d \- -f 2)
# build new version
version=$branch-$suffix
# run maven versions plugin to set new version
mvn versions:set -DgenerateBackupPoms=false -DnewVersion=$version
echo 'Changed version in pom.xml files to $version'
Have you checked the buildnumber-maven-plugin which gives you the opportunity to use the revision number of git. But you needed something different. Furthermore i would suggest to do a thing like:
1.0.0-SNAPSHOT
1.0.0-SNAPSHOT
beeing on master
on a branch you can simple change the version to
1.0.0-BF-SNAPSHOT
Disclaimer: I am the author
My maven core extension will virtually set the version based on the current branch or tag. You can config custom version format patterns as you like.
https://github.com/qoomon/maven-branch-versioning-extension
Version Format Example
Have you tried using this plugin?: https://github.com/ktoso/maven-git-commit-id-plugin. You can configure it to generate a properties file with all the relevant info about your repo state:
- branch
- describe
- commitId
- buildUserName
- buildUserEmail
- buildTime
- commitUserName
- commitUserEmail
- commitMessageShort
- commitMessageFull
- commitTime
If it is sufficient to set the git tag and version information in the artifact file name, you can use maven-jgit-buildnumber-plugin:
<build>
<finalName>${artifactId}-${git.buildnumber}</finalName>
<plugins>
<plugin>
<groupId>ru.concerteza.buildnumber</groupId>
<artifactId>maven-jgit-buildnumber-plugin</artifactId>
<version>1.2.7</version>
<executions>
<execution>
<id>git-buildnumber</id>
<goals>
<goal>extract-buildnumber</goal>
</goals>
<phase>prepare-package</phase>
</execution>
</executions>
</plugin>
<!-- more plugins -->
</plugins>
</build>
From maven-3.5.0 on there is support for ${revision}, ${sha1} and ${changelist} properties within the version tag. This feature may be sufficient for your purpose if, for example you want to incorporate the Git branchname into the version for a CI build job. See Maven CI Friendly Versions
Basically, in your pom.xml replace the fixed version by:
<version>${revision}${changelist}</version>
Set default values for revision and changelist in the project root dir by creating a file .mvn/maven.config
containing:
-Drevision=1.2.3
-Dchangelist=-SNAPSHOT
Check this file into version control, update it when you bump your project revision.
In your CI system you can then override the changelist variable using a cleaned-up representation of the Git branch name, eg.
# sed regex replaces non-(alphanumeric, dot or dash) char sequences with a dash
BRANCHNAME=$(git rev-parse --abbrev-ref HEAD | sed -E -e 's@[^0-9A-Za-z.-]+@-@g')
mvn clean install -Dchangelist="-${BRANCHNAME}"
(You may prefer git symbolic-ref --short HEAD
for fetching the branchname, YMMV)
Your artifact built by the CI system for branch feature/branchname
will then have a versioned-branch suffix like:
yourproject-1.2.3-feature-branchname.jar
whilst developers who do not use any overrides will still build it as:
yourproject-1.2.3-SNAPSHOT.jar