Build a C++ app with Jenkins

Ensure you are signed in to your GitHub account. If you don’t yet have a GitHub account, sign up for free on the GitHub website.

Fork the casino-number-guessing-game repository on GitHub into your local GitHub account. If you need help with this process, refer to the repository forking instructions on the GitHub website for more information.

Clone your forked casino-number-guessing-game repository from GitHub to your local 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 deployment, 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 cpp 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, such as casino-number-guessing-game, 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 selecting the green Code button in the main page of your GitHub repo.

In Branches to build, enter */main

In Script Path, set the script path to Jenkinsfile.

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

As you forked our sample repo, you already have an empty Jenkinsfile.

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

pipeline {
    agent any
    stages {
        stage('Build') { (1)
            steps {
                sh 'rm -rf build'
                sh 'cmake -B build -S .' (2)
                sh 'cmake --build build'
            }
        }
    }
}

Save your edited Jenkinsfile and commit it to your local casino-number-guessing-game Git repository. Within the casino-number-guessing-game directory, run the commands:
git add Jenkinsfile
then
git commit -m "Add initial Jenkinsfile"
and finally
git push to push your changes to your forked repository on GitHub, so it can be picked up by Jenkins.

Now select Build Now on the left pane of your Pipeline project in Jenkins. After making a clone of your local casino-number-guessing-game 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.

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:

        stage('Test') {
            steps {
                sh './build/casino_game'
                sh './build/test_game'
            }
        }

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'rm -rf build'
                sh 'cmake -B build -S .'
                sh 'cmake --build build'
            }
        }
        stage('Test') { (1)
            steps {
                sh './build/casino_game' (2)
                sh './build/test_game'
            }
        }
    }
}

Save your edited Jenkinsfile and commit it to your local casino-number-guessing-game Git repository. Within the casino-number-guessing-game directory, run the commands:
git add Jenkinsfile
then
git commit -m "Add 'Test' stage"
and finally
git push to push your changes to your forked repository on GitHub, so it can be picked up by Jenkins.

In Jenkins, go back to your Dashboard if necessary, then select casino-number-guessing-game and launch another build thanks to Build Now.

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

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 'tar -czf casino_game.tar.gz build/casino_game'
                archiveArtifacts artifacts: 'casino_game.tar.gz', fingerprint: true
            }
        }

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'rm -rf build'
                sh 'cmake -B build -S .'
                sh 'cmake --build build'
            }
        }
        stage('Test') {
            steps {
                sh './build/casino_game'
                sh './build/test_game'
            }
        }
        stage('Deliver') { (1)
            steps {
                sh 'tar -czf casino_game.tar.gz build/casino_game' (2)
                archiveArtifacts artifacts: 'casino_game.tar.gz', fingerprint: true (3)
            }
        }
    }
}

Save your edited Jenkinsfile and commit it to your local casino-number-guessing-game Git repository. Within the casino-number-guessing-game directory, run the commands:
git add Jenkinsfile
then
git commit -m "Add 'Deliver' stage"
and finally
git push to push your changes to your forked repository on GitHub, so it can be picked up by Jenkins.

In Jenkins, sign in if necessary, go back to the Dashboard, and then navigate to casino-number-guessing-game. Alternatively, you can go directly to casino-number-guessing-game depending on where you’re starting from.

Select Build Now on the left. After a while, a new column titled Deliver will appear in the Stage View.

Select #3, or on the number representing your last build on the left, under Build History.

Select Pipeline Overview to see the stages of the Pipeline.

Select the Deliver stage. You will then see a green part displaying tar -czf casino_game.tar.gz build/casino_game, which represents the successful execution of the tar command.

You can see the full stage view by clicking on the "Full Stage View" in the left menu.