Skip to main content

Maven Release Plugin

This post describes the installation and usage of the Maven Release Plugin. The plugin uses behind the scene a GIT repository configured in the SCM (Source Code Management) section of the POM (Project Object Model).

In your project's main pom.xml, add the following plugin inside you build / pluginManagement / plugins node.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-release-plugin</artifactId>
    <version>2.5.3</version>
    <configuration>
        <goals>deploy</goals>
        <autoVersionSubmodules>true</autoVersionSubmodules>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.apache.maven.scm</groupId>
            <artifactId>maven-scm-api</artifactId>
            <version>1.8.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.maven.scm</groupId>
            <artifactId>maven-scm-provider-gitexe</artifactId>
            <version>1.8.1</version>
        </dependency>
    </dependencies>
</plugin>

Although there is no explicit reference to the Maven SCM plugin, the Release plugin makes use of the SCM API and GIT provider packages.

Further in the pom.xml, we define the GIT repository to use:

<scm>
    <developerConnection>scm:git:https://server/your-repository.git</developerConnection>
    <tag>HEAD</tag>
</scm>

If distribution of binaries is enabled (e.g. using Artifactory), you can configure this under node distributionManagement in your pom.xml:

<distributionManagement>
    <snapshotRepository>
        <id>my-artifactory</id>
        <url>http://my-server/snapshot</url>
    </snapshotRepository>
    <repository>
        <id>my-artifactory</id>
        <url>http://my-server/release</url>
    </repository>
</distributionManagement>

Configure the credentials for repository in your ~/.m2/settings.xml file:

<server>
    <id>my-artifactory</id>
    <username>my-user</username>
    <password>UNENCRYPTED_PASSWORD</password>
</server>

Using the Maven Release Plugin

1. Make sure that:
a) all your stuff is checked in. Releases cannot be performed if any file not checked in/committed;
b) you have Java 1.8 and your JAVA_HOME points to it;

2. Go to command line (either PC or Mac… the commands are the same)

3. Go to the project you want to release (to root folder that contains the main pom.xml).
E.g.:
/Projects/rootFolder

4. Run command
mvn release:prepare

There will be tons of stuff going on, but this is an interactive process. You can select the release name, new SCM code name, next version development name, etc. AFAIK, all the defaults are fine. So don’t mess with this unless there is some good reason (such as you want to change the release name because something happened and a name is already taken)

5A. If command at #4 executed successfully, run command:
mvn release:perform

This will do the actual release, check-in stuff, upload bunch of deliverables to artifactory, etc.
If this step is successful, you’re done. No need for anything else. Check SourceTree (browse GIT) and marvel at your new release.
Note that currently the release is done in GIT under the name of the current user. This can be changed and be performed by some service account (but that is not the case for now). So the user running this command has to be able to check-out/check-in stuff in GIT.

5B. If command at #4 or #5A failed, run command:
mvn release:rollback

This will delete a bunch of temporary files and put the old version back in the POMs. You should run rollback before correcting any errors thrown during the release. Only after running ‘rollback’, proceed to change, fix and checkin/commit stuff.

6. Optional - run command:
mvn release:clean

This deletes a bunch of temporary directories used during the release/deploy phases. Not mandatory.



Comments

Popular posts from this blog

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Debugging a Tridion 2011 Event System

OK, so you wrote your Tridion Event System. Now it's time to debug it. I know this is a hypothetical situtation -- your code never needs any kind of debugging ;) but indulge me... Recently, Alvin Reyes ( @nivlong ) blogged about being difficult to know how exactly to debug a Tridion Event System. More exactly, the question was " What process do I attach to for debugging even system code? ". Unfortunately, there is no simple or generic answer for it. Different events are fired by different Tridion CM modules. These modules run as different programs (or services) or run inside other programs (e.g. IIS). This means that you will need to monitor (or debug) different processes, based on which events your code handles. So the usual suspects are: dllhost.exe (or dllhost3g.exe ) - running as the MTSUser is the SDL Tridion Content Manager COM+ application and it fires events on generic TOM objects (e.g. events based on Tridion.ContentManager.Extensibility.Events.CrudEven