The cutting of a diagnostic build, is the process where you want to deliver one or more oak bundles, let's say oak-core
into a specific environment in order to assess whether it actually solves the issues.
What you are aiming is to eventually produce a bundle in the format of, for example, oak-core-1.0.22-R2707077
.
Let‘s see it through examples. We’ll consider the case for Branches and Trunk.
We want to produce a diagnostic build of oak-core
for what it will be Oak 1.16.0. It means we currently have in our pom.xml
a version of <version>1.16-SNAPSHOT</version>
.
Open the Git working directory where trunk is and issue a
$ git pull $ git rev-parse --short HEAD
you will see something like
9c7d7bf569
which is the short Git hash of the most recent commit.
This means you'll produce a bundle with a version of 1.15-R9c7d7bf569
.
Note that the produced version is lower then the official release you're working on. 1.15 vs 1.16.0
Note to use the ‘-R’ (uppercase) instead of ‘-r’ (lowercase) as it will be lower than ‘-SNAPSHOT’. Doing otherwise will result in troubles when trying to apply a ‘-SNAPSHOT’ version on top of the internal build
If you're in doubt about what versioning and how OSGi or Maven will behave have a look at the Versionatorr App. You want your diagnostic build to be always less than the oak version where your fix is going to be released.
We want to produce a diagnostic build of oak-core
for what it will be Oak 1.0.23. It means we currently have in our pom.xml
a version of <version>1.0.23-SNAPSHOT</version>
.
Open the Git working directory where the relevant branch (in the example 1.0) is and issue a
$ git pull $ git rev-parse --short HEAD
you will see something like
9c7d7bf569
which is the short Git hash of the most recent commit in that branch.
This means you'll produce a bundle with a version of 1.0.22-R9c7d7bf569
.
Note that the produced version is lower then the official release you're working on. 1.0.22 vs 1.0.23
Note to use the ‘-R’ (uppercase) instead of ‘-r’ (lowercase) as it will be lower than ‘-SNAPSHOT’. Doing otherwise will result in troubles when trying to apply a ‘-SNAPSHOT’ version on top of the internal build
If you're in doubt about what versioning and how OSGi or Maven will behave have a look at the Versionatorr App. You want your diagnostic build to be always less than the oak version where your fix is going to be released.
Now. From our examples above you either want to produce 1.0.22-R9c7d7bf569`` or
1.15-R9c7d7bf569. For sake of simplicity we'll detail only the
1.0.22-R9c7d7bf569 case. For
1.15-R9c7d7bf569` you simply have to change the version.
Go into oak-parent
and issue the following maven command.
oak-parent$ mvn versions:set -DnewVersion=1.0.22-R9c7d7bf569
you may encounter the following exception. Simply ignore it. Nothing went wrong.
java.io.FileNotFoundException: .../oak-parent/oak-parent (No such file or directory)
Now you can build the release as usual
jackrabbit-oak$ mvn clean install
and you'll have a full oak build with the version 1.0.22-R9c7d7bf569
. Go into oak-core/target
and take the produced jar.
You don't want to commit the changes in Git just reset the branch to the original state
jackrabbit-oak$ mvn versions:revert