Build a Java app with Maven

Make sure you are signed in to your GitHub account. If you don’t yet have a GitHub account, sign up for free at GitHub.

Fork the simple-java-maven-app on GitHub into your local GitHub account. If you need help, refer to the GitHub documentation on forking a repo for more information.

Clone the forked simple-java-maven-app repository from GitHub 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:

Obtain the latest Jenkins instance, customized for this tutorial, by cloning the quickstart-tutorials repository.

After cloning, navigate to the quickstart-tutorials directory, and execute the command

docker compose --profile maven up -d

Once the containers are running successfully (you can verify this with docker compose ps), the controller can be accessed at http://localhost:8080.

In Jenkins, select New Item under Dashboard > at the top left.

Enter your new Pipeline project name in Enter an item name.

Scroll down if necessary and select Pipeline, then select OK at the end of the page.

(Optional) Enter a Pipeline Description.

Select Pipeline on the left pane.

Select Definition, and then choose the Pipeline script from SCM option. This option instructs Jenkins to obtain your Pipeline from the source control management (SCM), which is your forked Git repository.

Choose Git from the options in SCM.

Enter the URL of your repository in Repositories/Repository URL. This URL can be found when clicking on the green Code button in the main page of your GitHub repo.

Select Save at the end of the page. You’re now ready to create a Jenkinsfile to check into your locally cloned Git repository.

Using your preferred text editor or IDE, create and save a new text file named Jenkinsfile at the root of your local simple-java-maven-app Git repository.

Copy the following Declarative Pipeline code and paste it into your newly created Jenkinsfile:

pipeline {
    agent any
    stages {
        stage('Build') { (1)
            steps {
                sh 'mvn -B -DskipTests clean package' (2)
            }
        }
    }
}

Save your edited Jenkinsfile and commit it to your local simple-java-maven-app Git repository. Within the simple-java-maven-app directory, run the commands:

Now select Build Now on the left pane of your Pipeline project in Jenkins. After making a clone of your local simple-java-maven-app Git repository itself, Jenkins:

Initially queues the project to be run on the agent.

Runs the Build stage defined in the Jenkinsfile on the agent. During this time, Maven downloads many artifacts necessary to build your Java application, which are ultimately stored in Jenkins' local Maven repository.

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 your Jenkinsfile:

        stage('Test') {
            steps {
                sh 'mvn test'
            }
            post {
                always {
                    junit 'target/surefire-reports/*.xml'
                }
            }
        }

pipeline {
    agent any
    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)
                }
            }
        }
    }
}

Save your edited Jenkinsfile and commit it to your local simple-java-maven-app Git repository. Within the simple-java-maven-app directory, run the commands:

In Jenkins, go back to Dashboard if necessary, then Maven Tutorial and launch another build thanks to Build Now.

After a while, a new column Test appear in the Stage View.

You can click on #2 or on the number representing your last build on the left, under Build History. You will then see the details of the build.

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 your Jenkinsfile:

        stage('Deliver') {
            steps {
                sh './jenkins/scripts/deliver.sh'
            }
        }

pipeline {
    agent any
    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)
            }
        }
    }
}

Save your updated Jenkinsfile and commit it to your local simple-java-maven-app Git repository.

In Jenkins, sign in if necessary, and go back to the Dashboard and then Maven tutorial or go directly to Maven tutorial depending on where you’re starting from.

Select Build Now on the left. You should see after a while a new column Deliver appear in the Stage View.

You can click on #3 or on the number representing your last build on the left, under Build History. You will then see the details of the build.

You can now click on Maven tutorial on the top left, and then on Stages at the left. It will list your previous Pipeline runs in reverse chronological order.