Build a Java app with Maven

Open up a terminal window.

Create a bridge network in Docker using the following docker network create command:

docker network create jenkins

In order to execute Docker commands inside Jenkins nodes, download and run the docker:dind Docker image using the following docker run command:

docker run \
  --name jenkins-docker \(1)
  --rm \(2)
  --detach \(3)
  --privileged \(4)
  --network jenkins \(5)
  --network-alias docker \(6)
  --env DOCKER_TLS_CERTDIR=/certs \(7)
  --volume jenkins-docker-certs:/certs/client \(8)
  --volume jenkins-data:/var/jenkins_home \(9)
  --publish 2376:2376 \(10)
  --publish 3000:3000 --publish 5000:5000 \(11)
  docker:dind \(12)
  --storage-driver overlay2 (13)

docker run --name jenkins-docker --rm --detach \
  --privileged --network jenkins --network-alias docker \
  --env DOCKER_TLS_CERTDIR=/certs \
  --volume jenkins-docker-certs:/certs/client \
  --volume jenkins-data:/var/jenkins_home \
  --publish 3000:3000 --publish 5000:5000 --publish 2376:2376 \
  docker:dind --storage-driver overlay2

Customise official Jenkins Docker image, by executing below two steps:

Run your own myjenkins-blueocean:{jenkins-stable}-1 image as a container in Docker using the following docker run command:

docker run \
  --name jenkins-blueocean \(1)
  --detach \(2)
  --network jenkins \(3)
  --env DOCKER_HOST=tcp://docker:2376 \(4)
  --env DOCKER_CERT_PATH=/certs/client \
  --env DOCKER_TLS_VERIFY=1 \
  --publish 8080:8080 \(5)
  --publish 50000:50000 \(6)
  --volume jenkins-data:/var/jenkins_home \(7)
  --volume jenkins-docker-certs:/certs/client:ro \(8)
  --volume "$HOME":/home \(9)
  --restart=on-failure \(10)
  --env JAVA_OPTS="-Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true" \(11)
  myjenkins-blueocean:{jenkins-stable}-1 (12)

docker run --name jenkins-blueocean --detach \
  --network jenkins --env DOCKER_HOST=tcp://docker:2376 \
  --env DOCKER_CERT_PATH=/certs/client --env DOCKER_TLS_VERIFY=1 \
  --publish 8080:8080 --publish 50000:50000 \
  --volume jenkins-data:/var/jenkins_home \
  --volume jenkins-docker-certs:/certs/client:ro \
  --volume "$HOME":/home \
  --restart=on-failure \
  --env JAVA_OPTS="-Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true" \
  myjenkins-blueocean:{jenkins-stable}-1

Proceed to the Post-installation setup wizard.

Open up a command prompt window and similar to the macOS and Linux instructions above do the following:

Create a bridge network in Docker

docker network create jenkins

Run a docker:dind Docker image

docker run --name jenkins-docker --detach ^
  --privileged --network jenkins --network-alias docker ^
  --env DOCKER_TLS_CERTDIR=/certs ^
  --volume jenkins-docker-certs:/certs/client ^
  --volume jenkins-data:/var/jenkins_home ^
  --publish 3000:3000 --publish 5000:5000 --publish 2376:2376 ^
  docker:dind

Customise official Jenkins Docker image, by executing below two steps:

Run your own myjenkins-blueocean:{jenkins-stable}-1 image as a container in Docker using the following docker run command:

docker run --name jenkins-blueocean --detach ^
  --network jenkins --env DOCKER_HOST=tcp://docker:2376 ^
  --env DOCKER_CERT_PATH=/certs/client --env DOCKER_TLS_VERIFY=1 ^
  --volume jenkins-data:/var/jenkins_home ^
  --volume jenkins-docker-certs:/certs/client:ro ^
  --volume "%HOMEDRIVE%%HOMEPATH%":/home ^
  --restart=on-failure ^
  --env JAVA_OPTS="-Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true" ^
  --publish 8080:8080 --publish 50000:50000 myjenkins-blueocean:{jenkins-stable}-1

Proceed to the Setup wizard.

Run the same docker run …​ commands you ran for macOS, Linux or Windows above.

Browse to http://localhost:8080.

Wait until the log in page appears and log in.

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:

In Jenkins, sign in again if necessary, and select create new jobs under Welcome to Jenkins!. If your display is different, select New Item at the top left.

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

Scroll down 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 select the Pipeline script from SCM option. This option instructs Jenkins to obtain your Pipeline from source control management (SCM), which is your locally cloned Git repository.

Select Git from the options in SCM.

Enter the directory path of your locally cloned repository above in Script Path. This directory path from your user account/home directory on your host machine is mapped to the /home directory of the Jenkins container, according to your operating system, below:

Select Save to save your new Pipeline project. You’re now ready create a Jenkinsfile to check into your locally cloned Git repository.

Using your favorite text editor or IDE, create and save a new text file with the name Jenkinsfile at the root of your local simple-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.6-eclipse-temurin-17-alpine' (1)
            args '-v /root/.m2:/root/.m2' (2)
        }
    }
    stages {
        stage('Build') { (3)
            steps {
                sh 'mvn -B -DskipTests clean package' (4)
            }
        }
    }
}

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, sign in if necessary, and select Open Blue Ocean on the left pane.

Select Run from the This job has not been run options, then quickly select OPEN on the lower-right. If you cannot select OPEN in time, you can alternatively select the top row on the main Blue Ocean interface to display Jenkins running your project. You may need to wait several minutes for this first run to complete. After making a clone of your local simple-java-maven-app Git repository itself, Jenkins:

Select the X at the top-right to return to the main Blue Ocean interface.

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 {
        docker {
            image 'maven:3.9.6-eclipse-temurin-17-alpine'
            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)
                }
            }
        }
    }
}

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, sign in if necessary, and access the Blue Ocean interface.

Select Run at the top left, then quickly select OPEN, which appears briefly at the lower-right, to display Jenkins running your updated Pipeline project. Alternatively, you can select the top row on the Blue Ocean interface to display Jenkins running your updated Pipeline project.

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 {
        docker {
            image 'maven:3.9.6-eclipse-temurin-17-alpine'
            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)
            }
        }
    }
}

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

In Jenkins, sign in if necessary, and access Jenkins' Blue Ocean interface.

Select Run at the top left, then quickly select OPEN, which appears briefly at the lower-right, to display Jenkins running your updated Pipeline project. Alternatively, you can select the top row on the Blue Ocean interface to display Jenkins running your updated Pipeline project. The Blue Ocean interface displays as below if a Pipeline runs successfully. Notice the additional "Deliver" stage. Select the previous "Test" and "Build" stage circles to access the outputs from those stages.

Select the X at the top-right to return to the main Blue Ocean interface, which lists your previous Pipeline runs in reverse chronological order.