Build status badges in Jenkins - Commands & Configuration

Introduction

Build status badges show the current state of a Jenkins job's build. They help teams quickly see if the latest build passed or failed without opening Jenkins.

When you want to display the health of your project on a README file in GitHub.

When you want your team to quickly check if the latest build is stable from a dashboard.

When you want to include build status in documentation or project websites.

When you want to monitor multiple Jenkins jobs at a glance.

When you want to share build results with stakeholders who do not access Jenkins directly.

Commands

This command fetches the HTTP headers of the build status badge URL for the Jenkins job named 'my-app'. It verifies the badge URL is accessible.

Terminal

curl -I http://jenkins.example.com/job/my-app/badge/icon

Expected Output

HTTP/1.1 200 OK

Content-Type: image/svg+xml

Content-Length: 1234

Connection: keep-alive

This command downloads the build status badge image for the 'my-app' job and saves it as 'build-status.svg'. You can then embed this SVG in your README or website.

Terminal

curl http://jenkins.example.com/job/my-app/badge/icon > build-status.svg

Expected Output

No output (command runs silently)

This command appends Markdown syntax to the README.md file to display the build status badge image from Jenkins.

Terminal

echo "![Build Status](http://jenkins.example.com/job/my-app/badge/icon)" >> README.md

Expected Output

No output (command runs silently)

This command fetches the build status color in JSON format for the 'my-app' job. Useful for custom scripts to check build status programmatically.

Terminal

curl http://jenkins.example.com/job/my-app/api/json?tree=color

Expected Output

{"color":"blue"}

Key Concept

If you remember nothing else from this pattern, remember: Jenkins provides a simple URL to get a live build status badge image that you can embed anywhere.

Common Mistakes

Using the wrong job name or URL in the badge link.

The badge URL will return 404 or an error image, so the badge won't display correctly.

Double-check the Jenkins job name and URL path exactly as it appears in Jenkins.

Trying to use the badge URL without Jenkins being publicly accessible or without proper permissions.

The badge image won't load because Jenkins blocks unauthorized access.

Make sure Jenkins is accessible or configure anonymous read access for the badge URL.

Embedding the badge URL in places that do not support images or Markdown syntax.

The badge will not render and users won't see the build status.

Use the badge in Markdown files, HTML pages, or dashboards that support image rendering.

Summary

Use the Jenkins job badge URL to get a live build status image.

Download or embed the badge URL in README files or websites using Markdown syntax.

Verify the badge URL is accessible and uses the correct job name.

Practice

1. What does a Jenkins build status badge typically indicate?

easy

A. Whether the build is passing or failing

B. The number of tests in the project

C. The size of the build artifact

D. The time taken to complete the build

Solution

1. Step 1: Understand the purpose of build status badges

   Build status badges visually show the current state of a Jenkins job's build, mainly if it is passing or failing.

2. Step 2: Identify what the badge communicates

   The badge does not show test counts, artifact size, or build time; it only shows build success or failure.

3. Final Answer:

   Whether the build is passing or failing -> Option A

4. Quick Check:

   Build status badge = Pass/Fail [OK]

Hint: Badges show pass or fail status only [OK]

Common Mistakes:

• Confusing badge with test reports
• Thinking badge shows build duration
• Assuming badge shows artifact details

2. Which of the following is the correct format to get a Jenkins build status badge URL for a job named MyJob on http://jenkins.example.com?

easy

A. http://jenkins.example.com/MyJob/badge

B. http://jenkins.example.com/job/MyJob/badge/icon

C. http://jenkins.example.com/job/MyJob/build/badge

D. http://jenkins.example.com/job/MyJob/status/badge

Solution

1. Step 1: Recall Jenkins badge URL pattern

   The standard Jenkins badge URL for a job is: http://[jenkins_url]/job/[job_name]/badge/icon.

2. Step 2: Match the correct URL format

   http://jenkins.example.com/job/MyJob/badge/icon matches this pattern exactly for job MyJob.

3. Final Answer:

   http://jenkins.example.com/job/MyJob/badge/icon -> Option B

4. Quick Check:

   Badge URL = /job/JobName/badge/icon [OK]

Hint: Badge URL ends with /badge/icon [OK]

Common Mistakes:

• Omitting /job/ in URL
• Adding extra path segments like /build or /status
• Using incorrect order of URL parts

3. Given the Jenkins badge URL http://jenkins.example.com/job/TestProject/badge/icon, what will the badge image show if the last build failed?

medium

A. A green badge with 'passing' text

B. A yellow badge with 'unstable' text

C. A gray badge with 'not built' text

D. A red badge with 'failing' text

Solution

1. Step 1: Understand badge colors and meanings

   In Jenkins, a failed build shows a red badge labeled 'failing'.

2. Step 2: Match badge color to build status

   Since the last build failed, the badge will be red with 'failing' text.

3. Final Answer:

   A red badge with 'failing' text -> Option D

4. Quick Check:

   Failed build = red 'failing' badge [OK]

Hint: Red badge means build failed [OK]

Common Mistakes:

• Confusing red with green for success
• Thinking yellow means failure
• Assuming gray means failure

4. You added a build status badge URL to your README but the badge image shows 'not found'. What is the most likely cause?

medium

A. The Jenkins job name in the URL is incorrect

B. The Jenkins server is down

C. The badge URL is missing the /badge/icon suffix

D. The build is currently running

Solution

1. Step 1: Check common reasons for 'not found' badge

   A 'not found' badge usually means the URL points to a non-existent resource.

2. Step 2: Identify the most common URL mistake

   Incorrect job name in the URL causes Jenkins to return 404, showing 'not found' badge.

3. Final Answer:

   The Jenkins job name in the URL is incorrect -> Option A

4. Quick Check:

   Wrong job name = 'not found' badge [OK]

Hint: Check job name spelling in badge URL [OK]

Common Mistakes:

• Assuming server down causes 'not found'
• Forgetting /badge/icon suffix
• Thinking running build causes 'not found'

5. You want to embed a Jenkins build status badge in your GitHub README.md file for a job named DeployApp on http://ci.example.com. Which markdown snippet correctly embeds the badge image linking to the Jenkins job page?

hard

A. [](http://ci.example.com/job/DeployApp/badge/icon)

B. [Build Status](http://ci.example.com/job/DeployApp/badge/icon)

C. [](http://ci.example.com/job/DeployApp/)

D. 

Solution

1. Step 1: Understand markdown syntax for linked images

   Markdown syntax for an image with a link is: [](link URL).

2. Step 2: Apply correct URLs for Jenkins badge and job page

   The badge image URL is http://ci.example.com/job/DeployApp/badge/icon and the link should go to the job page http://ci.example.com/job/DeployApp/.

3. Final Answer:

   [](http://ci.example.com/job/DeployApp/) -> Option C

4. Quick Check:

   Markdown linked image = [](link) [OK]

Hint: Use [](job URL) for linked badge [OK]

Common Mistakes:

• Using image without link
• Linking badge URL instead of job URL
• Incorrect markdown syntax for images