Introduction
In the previous tutorial, how to create a web application manually is shown. Maven Deployment Automation chapter explains about the real-time projects build & deployment, automation process and functions of Maven release plug-in.
Description
In real-time projects, project deployment is typical and involves the following steps:
All the above steps will be followed by any team while working on real time projects. If any of the above steps are not followed, it results in project build and deployment failures. So, to complete the project successfully without any errors, the errors have to be handled automatically to prevent the application intervention. In Maven, Deployment Automation is the process that can automate the deployment process.
- Code checking in repository.
- Source code download from the repository.
- Application compiling, building and creating JAR/WAR files.
- Identifying the Jar/War files in shared network.
- Downloading Jar/War files and deploying to the server target.
- Documenting the application and updating the version details.
Conceptual
figure
Description
The automation of Maven build and deployment processes will be carried out by release plug-in. Open the
pom.xml file of previous application-WebApplication and rewrite the code as shown below.
[xml]
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.sample.webproject</groupId>
<artifactId>WebApplication</artifactId>
<packaging>war</packaging>
<version>1.0 </version>
<name>WebApplication Maven Webapp</name>
<url>http://maven.apache.org</url>
<scm>
<url>http://www.svn.com</url>
<connection>scm:svn:http://localhost:8011/svn/jrepo/trunk/Framework</connection>
<developerConnection>
scm:svn:test/test123@localhost:8011:common_core_api:1101:code
</developerConnection>
</scm>
<distributionManagement>
<repository>
<id>Sample-Web-App-Release</id>
<name>Release repository</name>
<url>
http://localhost:8082/nexus/content/repositories/Sample-Web-App-Release
</url>
</repository>
</distributionManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.0-beta-9</version>
<configuration>
<useReleaseProfile>false</useReleaseProfile>
<goals>deploy</goals>
<scmCommentPrefix>[Sample-Web-App-checkin]</scmCommentPrefix>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
[/xml]
The above XML file consists of 3 main tags.
| Element | Description |
|---|---|
| SCM | SCM configures the location of SVN where the source code is placed. |
| Repository | The location of JAR/WAR files after the project build is successful. |
| Plug-in | Release plugin used for deployment automation. |
Functions
Maven release plug-in will perform the following tasks when invoked by projects.
So, to automate the present project, run the following command to build the project.
- mvn release:clean – Workspace of the previous build should be cleaned before the next build arrives.
- mvn release:rollback – If the previous process is a failure, then it will rollback to the workspace.
- mvn release:prepare – Checks the non-committed files in workspace, verifies snapshot dependencies, release versions preparation, Pom updation to SCM, test case executions, performs final commit to SCM, code tagging, increments version number and adds Snapshot to support the further release versions.
- mvn release:perform – Verifies the code in repository, runs the build goals and deploys the artifact to the repository.
mvn release:prepare
After the build is successful, enter the below command to upload the WAR file into the repository.
mvn release:perform
Key Points
- Maven Deployment Automation removes the errors while generating the build for a project.
- SCM, repository and plug-in elements must be included in the pom.xml file.
- Clean, rollback, prepare and perform are the four operations performed by the release plug-in.
Programming
Tips
Make sure to have the same port number both in the server and pom file while deploying.