HTML reports publishing in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of HTML reports publishing in Jenkins?

It allows Jenkins to display test or build reports as web pages directly in the Jenkins interface, making results easy to view and share.

beginner

Which Jenkins plugin is commonly used to publish HTML reports?

The 'HTML Publisher Plugin' is used to publish HTML reports in Jenkins jobs.

beginner

What information do you need to provide when configuring HTML reports publishing in Jenkins?

You need to specify the directory where the HTML report files are stored and the index page name (usually index.html).

beginner

How does Jenkins display the published HTML reports after a build?

Jenkins adds a link to the build page that opens the HTML report in a new tab or window for easy viewing.

beginner

Why is publishing HTML reports useful in continuous integration?

It provides quick visual feedback on test results or build status, helping teams catch issues early and share results easily.

Which Jenkins plugin do you use to publish HTML reports?

A Git Plugin

B JUnit Plugin

C HTML Publisher Plugin

D Docker Plugin

The HTML Publisher Plugin is specifically designed to publish HTML reports in Jenkins.

What must you specify to publish an HTML report in Jenkins?

A Report directory and index page

B Git repository URL

C Build trigger schedule

D Docker image name

You specify the directory containing the HTML files and the main index page to publish the report.

Where does Jenkins show the link to the published HTML report?

A On the build's page

B In the system logs

C In the Jenkins global settings

D In the Jenkins dashboard only

The link appears on the specific build's page for easy access to the report.

What is a common file name for the main page of an HTML report?

A main.js

B build.log

C report.xml

D index.html

index.html is the standard main page file for HTML reports.

Why publish HTML reports in Jenkins?

A To manage user permissions

B To view test results visually

C To store source code

D To run builds faster

Publishing HTML reports helps teams see test or build results in a clear visual format.

Explain how to configure Jenkins to publish an HTML report after a build.

Think about the plugin and the settings needed to point Jenkins to your report files.

Describe the benefits of publishing HTML reports in a Jenkins continuous integration pipeline.

Consider how teams use reports to improve their work.

Practice

1. What is the main purpose of publishing HTML reports in Jenkins?

easy

A. To display test and build results inside Jenkins in a readable format

B. To execute shell commands during the build

C. To send email notifications after a build

D. To create new Jenkins jobs automatically

Solution

1. Step 1: Understand the role of HTML reports in Jenkins

   HTML reports are used to show test and build results in a user-friendly way inside Jenkins.

2. Step 2: Identify the correct purpose

   Among the options, only displaying results inside Jenkins matches the purpose of HTML reports.

3. Final Answer:

   To display test and build results inside Jenkins in a readable format -> Option A

4. Quick Check:

   HTML reports = readable results inside Jenkins [OK]

Hint: HTML reports show results inside Jenkins UI [OK]

Common Mistakes:

• Confusing HTML reports with build execution steps
• Thinking HTML reports send notifications
• Assuming HTML reports create jobs

2. Which of the following is the correct syntax to publish an HTML report in a Jenkins pipeline script?

easy

A. publishHTML { reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report' }

B. publishHTML(reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report')

C. publishHTML('reports', 'index.html', 'My Report')

D. publishHTML(target: [allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report'])

Solution

1. Step 1: Review the correct Jenkins pipeline syntax for publishHTML

   The publishHTML step requires a target map with keys like allowMissing, alwaysLinkToLastBuild, keepAll, reportDir, reportFiles, and reportName.

2. Step 2: Compare options to syntax

   publishHTML(target: [allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report']) correctly uses the target map with all required keys and proper syntax.

3. Final Answer:

   publishHTML(target: [allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report']) -> Option D

4. Quick Check:

   publishHTML uses target map syntax [OK]

Hint: Use publishHTML with target map and keys [OK]

Common Mistakes:

• Omitting the target keyword
• Passing parameters as separate arguments
• Using curly braces instead of parentheses

3. Given this Jenkins pipeline snippet:

publishHTML(target: [allowMissing: true, keepAll: false, reportDir: 'test-results', reportFiles: 'summary.html', reportName: 'Test Summary'])

What happens if the 'summary.html' file is missing after the build?

medium

A. The build will fail due to missing report file

B. The build will succeed and no report will be shown

C. Jenkins will create an empty report automatically

D. The build will pause and wait for the file

Solution

1. Step 1: Understand the allowMissing option

   allowMissing: true means Jenkins will not fail the build if the report file is missing.

2. Step 2: Predict behavior when file is missing

   Since allowMissing is true, the build succeeds but no report is shown.

3. Final Answer:

   The build will succeed and no report will be shown -> Option B

4. Quick Check:

   allowMissing true = no failure if missing [OK]

Hint: allowMissing true lets build pass without report [OK]

Common Mistakes:

• Assuming build fails when allowMissing is true
• Thinking Jenkins creates missing files
• Believing build pauses for missing files

4. You configured publishHTML in your Jenkins pipeline but the HTML report does not appear in the build results. Which of these is the most likely cause?

medium

A. The Jenkins server needs a restart

B. The publishHTML step is missing the allowMissing option

C. The reportDir path is incorrect or does not contain the report files

D. The reportName is too long

Solution

1. Step 1: Check common reasons for missing HTML reports

   If the reportDir path is wrong or empty, Jenkins cannot find the report files to display.

2. Step 2: Evaluate other options

   allowMissing missing does not prevent report display if files exist; reportName length and server restart are unrelated.

3. Final Answer:

   The reportDir path is incorrect or does not contain the report files -> Option C

4. Quick Check:

   Wrong reportDir = no report shown [OK]

Hint: Verify reportDir path and files exist [OK]

Common Mistakes:

• Ignoring reportDir correctness
• Thinking allowMissing affects report visibility
• Restarting Jenkins unnecessarily

5. You want Jenkins to keep all HTML reports from every build and always link to the latest report. Which configuration achieves this?

hard

A. publishHTML(target: [keepAll: true, alwaysLinkToLastBuild: true, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report'])

B. publishHTML(target: [keepAll: false, alwaysLinkToLastBuild: false, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report'])

C. publishHTML(target: [keepAll: true, alwaysLinkToLastBuild: false, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report'])

D. publishHTML(target: [keepAll: false, alwaysLinkToLastBuild: true, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report'])

Solution

1. Step 1: Understand keepAll and alwaysLinkToLastBuild options

   keepAll: true keeps reports from all builds. alwaysLinkToLastBuild: true creates a link to the latest report.

2. Step 2: Match options to requirement

   publishHTML(target: [keepAll: true, alwaysLinkToLastBuild: true, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report']) sets both keepAll and alwaysLinkToLastBuild to true, meeting the requirement.

3. Final Answer:

   publishHTML(target: [keepAll: true, alwaysLinkToLastBuild: true, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report']) -> Option A

4. Quick Check:

   keepAll and alwaysLinkToLastBuild true = keep all and link latest [OK]

Hint: Set keepAll and alwaysLinkToLastBuild to true [OK]

Common Mistakes:

• Setting keepAll false loses old reports
• Not linking to last build report
• Confusing option names