Build a Java app with Maven
This tutorial shows you how to use Jenkins to orchestrate building a simple Java application with Maven.
If you are a Java developer who uses Maven and who is new to CI/CD concepts, or you might be familiar with these concepts but don’t know how to implement building your application using Jenkins, then this tutorial is for you.
The simple Java application (which you’ll obtain from a sample repository on GitHub) outputs the string "Hello world!" and is accompanied by a couple of unit tests to check that the main application works as expected. The results of these tests are saved to a JUnit XML report.
Duration: This tutorial takes 20-40 minutes to complete (assuming you’ve already met the prerequisites below). The exact duration will depend on the speed of your machine and whether or not you’ve already run Jenkins in Docker from another tutorial.
You can stop this tutorial at any point in time and continue from where you left off.
If you’ve already run through another tutorial, you can skip the prerequisites and Run Jenkins in Docker sections below and proceed on to forking the sample repository. (Just ensure you have Git installed locally.) If you need to restart Jenkins, simply follow the restart instructions in run Jenkins in Docker and then proceed on.
Unresolved include directive in modules/ROOT/pages/build-a-java-app-with-maven.adoc - include::partial$_prerequisites.adoc[] ** Git and optionally GitHub Desktop.
Run Jenkins in Docker
In this tutorial, you’ll be running Jenkins as a Docker container from the
jenkins/jenkins
Docker
image.
To run Jenkins in Docker, follow the relevant instructions below for either macOS and Linux or Windows.
You can read more about Docker container and image concepts in the Docker section of the Installing Jenkins page.
Fork and clone the sample repository
Obtain the simple "Hello world!" Java application from GitHub, by forking the sample repository of the application’s source code into your own GitHub account and then cloning this fork locally.
-
Ensure you are signed in to your GitHub account. If you don’t yet have a GitHub account, sign up for a free one on the GitHub website.
-
Fork the
simple-java-maven-app
on GitHub into your local GitHub account. If you need help with this process, refer to the Fork A Repo documentation on the GitHub website for more information. -
Clone your forked
simple-java-maven-app
repository (on GitHub) locally to your machine. To begin this process, do either of the following (where<your-username>
is the name of your user account on your operating system):-
If you have the GitHub Desktop app installed on your machine:
-
In GitHub, click the green Clone or download button on your forked repository, then Open in Desktop.
-
In GitHub Desktop, before clicking Clone on the Clone a Repository dialog box, ensure Local Path for:
-
macOS is
/Users/<your-username>/Documents/GitHub/simple-java-maven-app
-
Linux is
/home/<your-username>/GitHub/simple-java-maven-app
-
Windows is
C:\Users\<your-username>\Documents\GitHub\simple-java-maven-app
-
-
-
Otherwise:
-
Open up a terminal/command line prompt and
cd
to the appropriate directory on:-
macOS -
/Users/<your-username>/Documents/GitHub/
-
Linux -
/home/<your-username>/GitHub/
-
Windows -
C:\Users\<your-username>\Documents\GitHub\
(although use a Git bash command line window as opposed to the usual Microsoft command prompt)
-
-
Run the following command to continue/complete cloning your forked repo:
git clone https://github.com/YOUR-GITHUB-ACCOUNT-NAME/simple-java-maven-app
whereYOUR-GITHUB-ACCOUNT-NAME
is the name of your GitHub account.
-
-
Create your Pipeline project in Jenkins
-
Go back to Jenkins, log in again if necessary and click create new jobs under Welcome to Jenkins!
Note: If you don’t see this, click New Item at the top left. -
In the Enter an item name field, specify the name for your new Pipeline project (e.g.
simple-java-maven-app
). -
Scroll down and click Pipeline, then click OK at the end of the page.
-
( Optional ) On the next page, specify a brief description for your Pipeline in the Description field (e.g.
An entry-level Pipeline demonstrating how to use Jenkins to build a simple Java application with Maven.
) -
Click the Pipeline tab at the top of the page to scroll down to the Pipeline section.
-
From the Definition field, choose the Pipeline script from SCM option. This option instructs Jenkins to obtain your Pipeline from Source Control Management (SCM), which will be your locally cloned Git repository.
-
From the SCM field, choose Git.
-
In the Repository URL field, specify the directory path of your locally cloned repository above, which is from your user account/home directory on your host machine, mapped to the
/home
directory of the Jenkins container - i.e.-
For macOS -
/home/Documents/GitHub/simple-java-maven-app
-
For Linux -
/home/GitHub/simple-java-maven-app
-
For Windows -
/home/Documents/GitHub/simple-java-maven-app
-
-
Click Save to save your new Pipeline project. You’re now ready to begin creating your
Jenkinsfile
, which you’ll be checking into your locally cloned Git repository.
Create your initial Pipeline as a Jenkinsfile
You’re now ready to create your Pipeline that will automate building your Java
application with Maven in Jenkins. Your Pipeline will be created as a
Jenkinsfile
, which will be committed to your locally cloned Git repository
(simple-java-maven-app
).
This is the foundation of "Pipeline-as-Code", which treats the continuous delivery pipeline as a part of the application to be versioned and reviewed like any other code. Read more about Pipeline and what a Jenkinsfile is in the Pipeline and Using a Jenkinsfile sections of the User Handbook.
First, create an initial Pipeline to download a Maven Docker image and run it as a Docker container (which will build your simple Java application). Also add a "Build" stage to the Pipeline that begins orchestrating this whole process.
-
Using your favorite text editor or IDE, create and save new text file with the name
Jenkinsfile
at the root of your localsimple-java-maven-app
Git repository. -
Copy the following Declarative Pipeline code and paste it into your empty
Jenkinsfile
:pipeline { agent { docker { image 'maven:3.9.0-eclipse-temurin-11' (1) args '-v /root/.m2:/root/.m2' (2) } } stages { stage('Build') { (3) steps { sh 'mvn -B -DskipTests clean package' (4) } } } }
1 This image
parameter (of theagent
section’sdocker
parameter) downloads themaven:3.9.0-eclipse-temurin-11
Docker image (if it’s not already available on your machine) and runs this image as a separate container. This means that:-
You’ll have separate Jenkins and Maven containers running locally in Docker.
-
The Maven container becomes the agent that Jenkins uses to run your Pipeline project. However, this container is short-lived - its lifespan is only that of the duration of your Pipeline’s execution.
2 This args
parameter creates a reciprocal mapping between the/root/.m2
(i.e. Maven repository) directories in the short-lived Maven Docker container and that of your Docker host’s filesystem. Explaining the details behind this is beyond the scope of this tutorial. However, the main reason for doing this is to ensure that the artifacts necessary to build your Java application (which Maven downloads while your Pipeline is being executed) are retained in the Maven repository beyond the lifespan of the Maven container. This prevents Maven from having to download the same artifacts during successive runs of your Jenkins Pipeline, which you’ll be conducting later on. Be aware that unlike the Docker data volume you created forjenkins-data
above, the Docker host’s filesystem is effectively cleared out each time Docker is restarted. This means you’ll lose the downloaded Maven repository artifacts each time Docker restarts.3 Defines a stage
(directive) calledBuild
that appears on the Jenkins UI.4 This sh
step (of thesteps
section) runs the Maven command to cleanly build your Java application (without running any tests). -
-
Save your edited
Jenkinsfile
and commit it to your localsimple-java-maven-app
Git repository. E.g. Within thesimple-java-maven-app
directory, run the commands:
git add .
then
git commit -m "Add initial Jenkinsfile"
-
Go back to Jenkins again, log in again if necessary and click Open Blue Ocean on the left to access Jenkins’s Blue Ocean interface.
-
In the This job has not been run message box, click Run, then quickly click the OPEN link which appears briefly at the lower-right to see Jenkins running your Pipeline project. If you weren’t able to click the OPEN link, click the row on the main Blue Ocean interface to access this feature.
Note: You may need to wait several minutes for this first run to complete. After making a clone of your localsimple-java-maven-app
Git repository itself, Jenkins:-
Initially queues the project to be run on the agent.
-
Downloads the Maven Docker image and runs it in a container on Docker.
-
Runs the
Build
stage (defined in theJenkinsfile
) on the Maven container. During this time, Maven downloads many artifacts necessary to build your Java application, which will ultimately be stored in Jenkins’s local Maven repository (in the Docker host’s filesystem).
The Blue Ocean interface turns green if Jenkins built your Java application successfully.
-
-
Click the X at the top-right to return to the main Blue Ocean interface.
Add a test stage to your Pipeline
-
Go back to your text editor/IDE and ensure your
Jenkinsfile
is open. -
Copy and paste the following Declarative Pipeline syntax immediately under the
Build
stage of yourJenkinsfile
:stage('Test') { steps { sh 'mvn test' } post { always { junit 'target/surefire-reports/*.xml' } } }
so that you end up with:
pipeline { agent { docker { image 'maven:3.9.0-eclipse-temurin-11' args '-v /root/.m2:/root/.m2' } } stages { stage('Build') { steps { sh 'mvn -B -DskipTests clean package' } } stage('Test') { (1) steps { sh 'mvn test' (2) } post { always { junit 'target/surefire-reports/*.xml' (3) } } } } }
1 Defines a stage
(directive) calledTest
that appears on the Jenkins UI.2 This sh
step (of thesteps
section) executes the Maven command to run the unit test on your simple Java application. This command also generates a JUnit XML report, which is saved to thetarget/surefire-reports
directory (within the/var/jenkins_home/workspace/simple-java-maven-app
directory in the Jenkins container).3 This junit
step (provided by the JUnit Plugin) archives the JUnit XML report (generated by themvn test
command above) and exposes the results through the Jenkins interface. In Blue Ocean, the results are accessible through the Tests page of a Pipeline run. Thepost
section’salways
condition that contains thisjunit
step ensures that the step is always executed at the completion of theTest
stage, regardless of the stage’s outcome. -
Save your edited
Jenkinsfile
and commit it to your localsimple-java-maven-app
Git repository. E.g. Within thesimple-java-maven-app
directory, run the commands:
git stage .
then
git commit -m "Add 'Test' stage"
-
Go back to Jenkins again, log in again if necessary and ensure you’ve accessed Jenkins’s Blue Ocean interface.
-
Click Run at the top left, then quickly click the OPEN link which appears briefly at the lower-right to see Jenkins running your amended Pipeline project. If you weren’t able to click the OPEN link, click the top row on the Blue Ocean interface to access this feature.
Note: You’ll notice from this run that Jenkins no longer needs to download the Maven Docker image. Instead, Jenkins only needs to run a new container from the Maven image downloaded previously. Also, if Docker had not restarted since you last ran the Pipeline above, then no Maven artifacts need to be downloaded during the "Build" stage. Therefore, running your Pipeline this subsequent time should be much faster.
If your amended Pipeline ran successfully, here’s what the Blue Ocean interface should look like. Notice the additional "Test" stage. You can click on the previous "Build" stage circle to access the output from that stage. -
Click the X at the top-right to return to the main Blue Ocean interface.
Add a final deliver stage to your Pipeline
-
Go back to your text editor/IDE and ensure your
Jenkinsfile
is open. -
Copy and paste the following Declarative Pipeline syntax immediately under the
Test
stage of yourJenkinsfile
:stage('Deliver') { steps { sh './jenkins/scripts/deliver.sh' } }
and add a
skipStagesAfterUnstable
option so that you end up with:pipeline { agent { docker { image 'maven:3.9.0-eclipse-temurin-11' args '-v /root/.m2:/root/.m2' } } options { skipStagesAfterUnstable() } stages { stage('Build') { steps { sh 'mvn -B -DskipTests clean package' } } stage('Test') { steps { sh 'mvn test' } post { always { junit 'target/surefire-reports/*.xml' } } } stage('Deliver') { (1) steps { sh './jenkins/scripts/deliver.sh' (2) } } } }
1 Defines a new stage called Deliver
that appears on the Jenkins UI.2 This sh
step (of thesteps
section) runs the shell scriptdeliver.sh
located in thejenkins/scripts
directory from the root of thesimple-java-maven-app
repository. Explanations about what this script does are covered in thedeliver.sh
file itself. As a general principle, it’s a good idea to keep your Pipeline code (i.e. theJenkinsfile
) as tidy as possible and place more complex build steps (particularly for stages consisting of 2 or more steps) into separate shell script files like thedeliver.sh
file. This ultimately makes maintaining your Pipeline code easier, especially if your Pipeline gains more complexity. -
Save your edited
Jenkinsfile
and commit it to your localsimple-java-maven-app
Git repository. E.g. Within thesimple-java-maven-app
directory, run the commands:
git stage .
then
git commit -m "Add 'Deliver' stage"
-
Go back to Jenkins again, log in again if necessary and ensure you’ve accessed Jenkins’s Blue Ocean interface.
-
Click Run at the top left, then quickly click the OPEN link which appears briefly at the lower-right to see Jenkins running your amended Pipeline project. If you weren’t able to click the OPEN link, click the top row on the Blue Ocean interface to access this feature.
If your amended Pipeline ran successfully, here’s what the Blue Ocean interface should look like. Notice the additional "Deliver" stage. Click on the previous "Test" and "Build" stage circles to access the outputs from those stages.Here’s what the output of the "Deliver" stage should look like, showing you the execution results of your Java application at the end.
-
Click the X at the top-right to return to the main Blue Ocean interface, which lists your previous Pipeline runs in reverse chronological order.
Wrapping up
Well done! You’ve just used Jenkins to build a simple Java application with Maven!
The "Build", "Test" and "Deliver" stages you created above are the basis for building more complex Java applications with Maven in Jenkins, as well as Java and Maven applications that integrate with other technology stacks.
Because Jenkins is extremely extensible, it can be modified and configured to handle practically any aspect of build orchestration and automation.
To learn more about what Jenkins can do, check out:
-
The Tutorials overview page for other introductory tutorials.
-
The User Handbook for more detailed information about using Jenkins, such as Pipelines (in particular Pipeline syntax) and the Blue Ocean interface.
-
The Jenkins blog for the latest events, other tutorials and updates.