This is a Jenkins Build Wrapper for Maven Jobs. It enables you to
perform Maven releases using the
Apache Maven Unleash Plugin.
That plugin is providing significant advantage for a Maven release process versus the original Maven release plugin like:
- Checking for SNAPSHOT dependencies
- Rolling back previous step transactions - like SCM commits - in case of a release process step failing
- CDI based custom extendable default workflows
See unleash-maven-plugin Wiki for details.
This plugin has recovered from deprecation tagged by 21-Dec-2022 since
the Apache Maven Unleash Plugin did continue to be actively maintained.
That plugin did move by a new groupId to Maven coordinate io.github.mavenplugins:unleash-maven-plugin.
It is working seamlessly for Maven >= 3.3.9 on Java 8, 11, 17 and 21 since unleash-maven-plugin version 3.0.0.
This section describes the project configuration options as well as the actual usage of the plugin when building Maven releases.
In order to use the plugin for building Maven releases you will have to
enable it first in the configuration of your Maven build job. Go to the
Build Environment section and enable the build wrapper by checking
the Unleash box.
Then you will see some input fields for basic settings. There you can
add the required profiles and options for your release build. The goals
are pre-defined because currently unleash:perform is the only goals that
makes sense there.
Clicking the Advanced... button shows some additional settings for
workflow overriding, SCM-related settings and some checkboxes that
affect the actual release form that we use later.
The Hook Data section can then be used for really advanced stuff. If you
f.i. extend the default workflow and add an exec-hook to the workflow,
you will be able to provide data for the hook execution at this point.
The usage of the plugin is pretty simple and is nothing more than
submitting a form on a subpage of the project.
After you've enabled the plugin a link will be shown on the left side of
the screen called Trigger Unleash Maven Plugin:
After clicking on this link you will be directed to the form page where
you can start the release build for your project.
On this page you can either specify a global version for all modules of
the project (for release and dev) or you stick to the versions provided
by the plugin and listed in the table which allows independent versioning
of modules.
You can also provide custom SCM credentials, override the tag name pattern
and/or SCM message prefix or request some other stuff.
Once you have some successful or failed release builds you can also get
some project-related release information, such as the badge icons
indicating successful or failed releases.
There are also two permalinks available, one for successful and one for
failed releases.
Finally there are some ListView columns:
Issues around this plugin are tracked in the Jenkins Issue Tracker. To browse open issues please visit this page. There you can also file new ones if necessary.
Report an issue for this plugin via Report an Issue for the Jenkins Unleash Plugin
General information about the usage of the Unleash Maven Plugin can be found here:
Substantial parts of the plugin sources have been extracted from the M2
Release Plugin. It served as a base for getting started since the
feature set was very similar.
Please find further copyright notes in the source code.
See Releases