Publishing HTML Reports in Pipeline

Written by: Liam Newman
1 min read
Stay connected
Most projects need more than just JUnit result reporting. Rather than writing a custom plugin for each type of report, we can use the [HTML Publisher Plugin]( ## Let's Make this Quick I've found a Ruby project, [hermann](, I'd like to build using Jenkins Pipeline. I'd also like to have the code coverage results published with each build job. I could write a plugin to publish this data, but I'm in a bit of a hurry and the build already creates an HTML report file using [SimpleCov]( when the unit tests run. ## Simple Build I'm going to use the [HTML Publisher Plugin]( to add the HTML-formatted code coverage report to my builds. Here's a simple pipeline for building the [hermann]( project.
stage 'Build'

node {
  // Checkout
  checkout scm

  // install required bundles
  sh 'bundle install'

  // build and run tests with coverage
  sh 'bundle exec rake build spec'

  // Archive the built artifacts
  archive (includes: 'pkg/*.gem')
> __NOTE:__ > This pipeline expects to be run from a `Jenkinsfile` in SCM. > To copy and paste it directly into a Jenkins Pipeline job, replace the `checkout scm` step with > `git ''`. Simple enough, it builds, runs tests and archives the package. --- ![Job Run Without Report Link]( "Job Run Without Report Link") --- Now I just need to add the step to publish the code coverage report. I know that `rake spec` creates an `index.html` file in the `coverage` directory. I've already installed the [HTML Publisher Plugin]( How do I add the HTML publishing step to the pipeline? The plugin page doesn't say anything about it. ## Snippet Generator to the Rescue Documentation is hard to maintain and easy to miss, even more so in a system like Jenkins with hundreds of plugins with each potentially having one or more groovy fixtures to add to the Pipeline. The Pipeline Syntax ["Snippet Generator"]( helps users navigate this jungle by providing a way to generate a code snippet for any step using provided inputs. It offers a dynamically generated list of steps, based on the installed plugins. From that list I select the `publishHTML` step: --- ![Snippet Generator Menu]( "Snippet Generator Menu") --- Then it shows me a UI similar to the one used in job configuration. I fill in the fields, click "generate" and it shows me snippet of groovy generated from that input. --- ![Snippet Generator Output]( "Snippet Generator Output") ## HTML Published I can use that snippet directly or as a template for further customization. In this case, I'll just reformat and copy it in at the end of my pipeline. (I ran into a [minor bug]( in the snippet generated for this plugin step. Typing error string in my search bar immediately found the bug and a workaround.)
  /* ...unchanged... */

  // Archive the built artifacts
  archive (includes: 'pkg/*.gem')

  // publish html
  // snippet generator doesn't include "target:"
  publishHTML (target: [
      allowMissing: false,
      alwaysLinkToLastBuild: false,
      keepAll: true,
      reportDir: 'coverage',
      reportFiles: 'index.html',
      reportName: "RCov Report"

When I run this new pipeline I am rewarded with an `RCov Report` link on left side, which I can follow to show the HTML report. --- ![Job Run With Report Link]( "Job Run With Report Link") --- ![RCov Report]( "RCov Report") --- I even added the `keepAll` setting to let me go back and look at reports on old jobs as more come in. As I said to begin with, this is not as slick as what I could do with a custom plugin, but it is much easier and works with any static HTML. ## Links * [HTML Publisher Plugin]( * [Snippet Generator]( #### *This is the second in a series of posts showing ways to use Jenkins Pipeline. Follow along with this entire series through the links below:* * *[Faster Pipelines with the Parallel Test Executor Plugin](* * *Publishing HTML Reports in Pipeline* * *[Sending Notifications in Pipeline](* * *[Browser-testing with Sauce OnDemand and Pipeline](* * *[Continuous Security for Rails apps with Pipeline and Brakeman](* * *[xUnit and Pipeline](*

Learn More

Jenkins is one of the preeminent automation tools. Jenkins is extensible by design, using plugins. Plugins are what give Jenkins its great flexibility for automating a wide range of processes on diverse platforms. Jenkins Pipeline builds on that flexibility and rich plugin ecosystem while enabling Jenkins users to write their Jenkins automation as code. This technical guide will show a number of common use cases for plugins with Jenkins Pipeline.

These use cases include:

  • Publishing HTML reports
  • Sending notifications
  • Continuous delivery using Docker
  • Test result interpretation and reporting

Download this technical guide to learn more about and get started with Jenkins Pipeline!


Stay up to date

We'll never share your email address and you can opt out at any time, we promise.

Loading form...
Your ad blocker may be blocking functionality on this page. Please disable for an improved experience.