HTML Publisher Plugin

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID htmlpublisher Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Dependencies
1.5 (archives)
Jul 26, 2015
1.424
Source Code
Issue Tracking
Pull Requests
Maintainer(s)
GitHub
Open Issues
Pull Requests
Michael Rooney (id: mcrooney)
Usage Installations 2014-Jul 14100
2014-Aug 14300
2014-Sep 14974
2014-Oct 15372
2014-Nov 15426
2014-Dec 15505
2015-Jan 16038
2015-Feb 16409
2015-Mar 17302
2015-Apr 17491
2015-May 17466
2015-Jun 18184

This plugin publishes HTML reports.

Installation Steps:

1. Go to Jenkins Dashboard
2. Click on the link that says "Manage Jenkins"
3. On the Plugin Manager page, go to the "Available" tab next to Updates tab
4. Look for the html publisher plugin, select the checkbox and click install. Wait for it come back with status "Success".
5. Restart Jenkins by clicking the provided link on the success page, or if using tomcat, executing <tomcat-Jenkins>/bin/shutdown.sh and <tomcat-Jenkins>/bin/startup.sh

How to use HTML Publisher Plugin:

HtmlPublisher plugin is useful to publish the html reports that your build generates to the job and build pages. Below are the steps to publish and archive the HTML report files

1. Click on the Configure option for your Jenkins job.

2. In the post build portion, look for the Publish HTML Reports option and select the checkbox. See the screen shot below

Fill the path to the directory containing the html reports in the "HTML directory to archive" field. Specify the pages to display (default index.html); you can specify multiple comma-separated pages and each will be a tab on the report page. Finally, give a name in the Report Title field, which will be used to provide a link to the report. By default, only the most recent HTML report will be saved, but if you'd like to be able to view HTML reports for each past build, select "Keep past HTML reports."

Some time at HTML directory, you don't have to specify project name, but have to start one level below. For e.g. if your project name is "ABC" and if HTML files are at "ABC/report-output/html" then you have to specify just \test-output\html\.

3. After saving the configuration, run build once. The published HTML reports are available to view from within Jenkins with convenient links in the dashboard.

Version History

Version 1.5 (July 26th, 2015)

  • Clean up / improve the configuration UI
  • Restore removed constructor in 1.4 to fix binary compatibility (JENKINS-29626)

Version 1.4 (May 24th, 2015)

  • Add an option to publish HTML reports even if the build fails. (JENKINS-11689, JENKINS-24057)

Version 1.4 (May 24th, 2015)

  • Add an option to publish HTML reports even if the build fails. (JENKINS-11689, JENKINS-24057)

Version 1.3 (Nov 13th, 2013)

  • Add an option to allow a build not to fail if a report is not present
  • fix "html publisher plugin overrides report encoding with iso-8859-1" JENKINS-19268

Version 1.2 (Dec 10th, 2012)

  • revert "support Ant patterns in archive directory" to fix JENKINS-16083

Version 1.1 (Dec 7th, 2012)

  • support Ant patterns in archive directory
  • fix viewing HTML report for specific builds (12967@issue)
  • fix NPE (14491@issue)

Version 1.0 (May 10th, 2012)

  • Support environment variables when configuring the report directory and index pages (10273@issue)

Version 0.8 (Apr 26th, 2012)

  • Add empty descriptor to HtmlPublisherTarget (issue #12258)
  • Scrollbar in HTML publisher due to 100% height on div/iframe (issue #13070)
  • HTML Publisher does not work for multi-configuration projects (issue #8832)

Version 0.7 (Aug 2nd, 2011)

  • Update to work with Jenkins 1.418+

Version 0.6 (Jan 20th, 2011)

  • Added Zip option to HTML Report View - this will provide a Zip file of the contents of the particular report (issue #8163)

Version 0.5 (Jan 20th, 2011)

  • This version unintentionally left blank

Version 0.4 (May 24th, 2010)

  • The "Back to Jenkins" link is now "Back to JOBNAME" and goes back to the job instead of the Jenkins root (issue #6521)

Version 0.3 (May 10th, 2010)

  • display per-build report links after a restart (only works for builds after the upgrade, alas) (issue #5775)
  • don't display report links if there aren't reports yet (issue #5683)
  • "Back to Jenkins" link triggers a back action in the browser if the user hasn't configured the Jenkins URL (issue #6434)

Version 0.2.2 (Feb 17th, 2010)

  • Show all project-level reports on the project page, not just the first (issue #5069)

Version 0.1.0

  • Initial release from abstraction of NCover plugin, allowing for archiving and displaying of HTML report directories

Labels

plugin-upload plugin-upload Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jan 27, 2011

    Anna Saranti says:

    Hi, I am archiving the results of a Hudson job run according to the Job'sName a...

    Hi,

    I am archiving the results of a Hudson job run according to the Job'sName and BuildNumber.

    For that I'm using the environmental variables %JOB_NAME% and %BUILD_NUMBER%.

    Is it possible to use this variables into the path of the .html file in "HTML directory to archive"?

    For example C:\MyResults%JOB_NAME%_%BUILD_NUMBER%

    Thanks

    1. Nov 09, 2011

      Adil Akhund-Zade says:

      I have exactly the same problem. I don't know a  workaround to that. There ...

      I have exactly the same problem. I don't know a  workaround to that. There is an issue for this: https://issues.jenkins-ci.org/browse/JENKINS-10273&nbsp;

      I vote for the fix

      1. Jan 05, 2012

        Emidio Stani says:

        I would need the same. My case: I have ant properties file and I would like to r...

        I would need the same. My case: I have ant properties file and I would like to reuse the variables in the job (there is a EnvInject plugin for this) like in the Html Publisher plugin but the latter doesn't accept them.

        +1 vote :-)

        1. May 10, 2012

          Stan Binev says:

          +1 This is essential! I can't believe this plugin is not supporting tha...

          +1

          This is essential! I can't believe this plugin is not supporting that!

          1. May 10, 2012

            Michael Rooney says:

            This should be working in 1.0, please give it a shot.

            This should be working in 1.0, please give it a shot.

  2. Sep 27, 2011

    Olaf Lenz says:

    This plugin and the DocLinks Plugin basically seem to do the same. Wouldn't...

    This plugin and the DocLinks Plugin basically seem to do the same. Wouldn't it be smart to merge them? Or is one of them more up-to-date?

  3. Feb 28, 2012

    William Lichtenberger says:

    The HTML reports don't seem to be published on the build if the build is marked ...

    The HTML reports don't seem to be published on the build if the build is marked as unstable.  It updates the job's HTML report, but doesn't seem to attach the report to the build.  Is there a workaround for this?

    <note:  Never mind, either myself or a teammate had unchecked 'Keep past HTML reports'>

  4. Mar 27, 2012

    Jim Green says:

    This plugin is very good, very useful,  One thing I want to say is that, w...

    This plugin is very good, very useful, 

    One thing I want to say is that, when click "back to " link in the html report page, it will return to the project page, could it return to the corresponding build page according to the build number?

    i want to modify it myself, but I don't know how to do it. 

    Hope one day I could modify it as my will.

  5. Mar 27, 2012

    Jim Green says:

    One more thing,  When the HTML report page also contain the Jenkins's head...

    One more thing, 

    When the HTML report page also contain the Jenkins's header, slider and the foot page? so that the report will seems very good looking with Jenkins.

    Maybe I should do it myself, because others maybe don't like this,  but I don't know how to modify the content in the class file. I can change the code in java file, but i don't know how to compile it into java file.

    Anyone can help with this ?  

    thanks very much.

  6. May 03, 2012

    Gangadharan Ramakrishnan says:

    I am using the groovy and jelly templates to send out build notifications. ...

    I am using the groovy and jelly templates to send out build notifications. Is it possible in Jenkins to email out this HTML report along with the build status?

    1. May 03, 2012

      Michael Rooney says:

      This question isn't related to the HTML Publisher plugin and is perhaps better s...

      This question isn't related to the HTML Publisher plugin and is perhaps better suited the Jenkins users mailing list, but you can likely do this. Either just use Groovy to read the contents of the HTML file and inject it into the email, or use something like the EnvInject plugin to inject the HTML into an environment variable and use it from your template.

  7. Jan 28, 2013

    Max Liu says:

    Hi, Can the plugin support wildcard *.html instead of specifying the name f...

    Hi,

    Can the plugin support wildcard *.html instead of specifying the name for every html?

    Max

    1. Jan 29, 2013

      Michael Rooney says:

      It does not currently, though this is https://issues.jenkins-ci.org/browse/...

      It does not currently, though this is https://issues.jenkins-ci.org/browse/JENKINS-7139, which in the comments has a couple suggestions for workarounds.

  8. May 16, 2013

    rock dude says:

    I am using Jenking to run my selenium scripts on a remote server. My question i...

    I am using Jenking to run my selenium scripts on a remote server. My question is "Is there any way to visually see my scripts running on the server? I mean on an actual browser when scripts are running in Jenkins?"

  9. May 20, 2013

    Adil Akhund-Zade says:

    User abdurrahaman duwila added two html attachments containing malware to t...

    User abdurrahaman duwila added two html attachments containing malware to this page. I could find no place to report this on Wiki. I post it here just to warn the others. 

    Should be there an e-mail to send complaints to?

  10. Aug 01, 2013

    Jon Starbird says:

    I've setup the plugin and it is copying my reports that I am pointing it to but ...

    I've setup the plugin and it is copying my reports that I am pointing it to but the links are not working. None of them.

    I have my buildsdir configured to someplace other than Jenkins/Jobs  do you not look at the setting for that and only use Jenkins/Jobs? 

    1. Aug 02, 2013

      Jon Starbird says:

      Solved the issue.  Filename had a typo in it. (head firmly slapped!)

      Solved the issue.  Filename had a typo in it. (head firmly slapped!)

  11. Aug 22, 2013

    Alexander Artemov says:

    After upgrade Jenkins to ver. 1.528 HTML reports become unaccessible - and newly...

    After upgrade Jenkins to ver. 1.528 HTML reports become unaccessible - and newly published as well:

    Status Code: 404

    1. Aug 25, 2013

      Jesse Jacob says:

      Argh! Me too. No other changes on the CI box except for the Jenkins upgrade.

      Argh! Me too. No other changes on the CI box except for the Jenkins upgrade.

      1. Sep 03, 2013

        Paul Adams says:

        Yes, seems to be a fundamental Jenkins problem with 1.528 and 1.529. The Doxygen...

        Yes, seems to be a fundamental Jenkins problem with 1.528 and 1.529. The Doxygen plugin now has the same problem as well!

        1. Sep 03, 2013

          Michael Rooney says:

          Hey there, plugin author here. It was a Jenkins core bug that should be fixed in...

          Hey there, plugin author here. It was a Jenkins core bug that should be fixed in 1.530: https://issues.jenkins-ci.org/browse/JENKINS-19281. You can wait for its release or roll back to 1.527. Sorry about that!

  12. Nov 07, 2013

    Shannon Kerr says:

    I'd like to be able to put my publish link (in my case "Build Artifacts") as a c...

    I'd like to be able to put my publish link (in my case "Build Artifacts") as a column in the Jenkins View.  Can you add support for this please?

  13. Dec 10, 2013

    jerome metayer says:

    I would like to be able to specify where HTML publisher archive things: is there...

    I would like to be able to specify where HTML publisher archive things: is there any way of doing this or a plan for that ?

    ( using a combination of HTML publisher + artifact deployer  where html publisher is just there to provide me with a nice looking link )

    thank you

    1. Dec 10, 2013

      Michael Rooney says:

      Hi Jerome! HTML Publisher is primarily for providing the link and serving th...

      Hi Jerome! HTML Publisher is primarily for providing the link and serving the HTML, as you say. If you want the archive to end up elsewhere, I think you'd be best served by a build step that copies the HTML wherever you desire, or using a plugin as you mentioned. If you aren't keeping past HTML reports, you may also be able to symlink the report directory elsewhere if the desired destination is on the filesystem or otherwise mounted.

      1. Dec 12, 2013

        jerome metayer says:

        Hi Michael the problem I have may then be linked to my setup I am using a slav...

        Hi Michael

        the problem I have may then be linked to my setup

        I am using a slave Jenkins to run some tasks on a remote PC and then using HTML  publisher

        what I end up with after running HTML publisher is two copies of the output data of my tasks on the master Jenkins's workspace:  two directories "jobName/number/htmlReports" and "jobName/date/htmlReports"

        If I just use "artifactDeployer", I end up with a single directory "jobName/number" where I chose to put them, but I do not have my link.

        so it feels like "HTML publisher" is doing more than giving me a link and that is creating 2 copies of the data onto the master jenkins workspace

  14. Apr 22, 2014

    Lothar Schlesier says:

    Hello, a nice feature for the plugin would be an option to name a file (located...

    Hello,

    a nice feature for the plugin would be an option to name a file (located in the report directory) to be used as icon for individual reports. This would allow to highlight reports that need more attention than others.

    Thank you for this useful plugin!

  15. Aug 14, 2014

    Eldad Assis says:

    Hi all, I'm having a strange behavior where the logs are created fine, but the ...

    Hi all,

    I'm having a strange behavior where the logs are created fine, but the link on the main Job's page shows old logs although the links in the individual builds pages are fine.
    Has anyone seen this or has an idea on how to resolve?

    Thx,
    Eldad

  16. Sep 29, 2014

    Neven DInev says:

    How can I archive only single HTML file If I enter only html file name (like re...

    How can I archive only single HTML file

    If I enter only html file name (like report.html) the plugin archives the whole workspace?! (my html file is in the root of the workspace)

    1. Sep 30, 2014

      Michael Rooney says:

      It will archive the directory containing the report as reports often contain ima...

      It will archive the directory containing the report as reports often contain images, CSS, and other goodies they link to.

      If you just have a single file, simply put it in a directory. For example, perhaps your last build step would be executing shell such as "mkdir -p reports && mv report.html reports", and then change your HTML Publisher report path to "reports/report.html". Ta-da!

  17. Oct 08, 2014

    Deepthi Panthula says:

    Hi - Slave jenkins which runs the tasks including post build actions (i.e runnin...

    Hi - Slave jenkins which runs the tasks including post build actions (i.e running the html publish plugin) goes offline before the data is copied over to jenkins master and build fails saying the html output directory cannot be found.

    Have any of you encountered this issue?

    Thanks!

  18. Apr 08

    María García says:

    Hi, I have a problem with my HTML Report because there are HTML report files to...

    Hi,

    I have a problem with my HTML Report because there are HTML report files to logs. The logs are not found and it shows an error HTTP 404.

    How can I solve this error?

    Thanks and regards.

  19. Apr 23

    Steve Jein says:

    After a recent upgrade to Jenkins 1.610, I now see a build using the HTML publis...

    After a recent upgrade to Jenkins 1.610, I now see a build using the HTML publisher plug-in 1.3 fail with the following error.

    The upgrade to Jenkins server was the only significant change for this job. Is anyone else experiencing this issue in newer versions of Jenkins?

     [htmlpublisher] Archiving HTML reports...
    [htmlpublisher] Archiving at BUILD level /var/lib/jenkins-remote-root/workspace/dashboard-gerrit/platoReport to /var/lib/jenkins/jobs/dashboard-gerrit/builds/75/htmlreports/Code_Analysis_Report
    FATAL: HTML Publisher failure
    java.io.IOException: Failed to extract /var/lib/jenkins-remote-root/workspace/dashboard-gerrit/platoReport/**/*
        at hudson.FilePath.readFromTar(FilePath.java:2299)
        at hudson.FilePath.copyRecursiveTo(FilePath.java:2208)
        at hudson.FilePath.copyRecursiveTo(FilePath.java:2112)
        at hudson.FilePath.copyRecursiveTo(FilePath.java:2095)
        at htmlpublisher.HtmlPublisher.perform(HtmlPublisher.java:213)
        at hudson.tasks.BuildStepMonitor$1.perform(BuildStepMonitor.java:20)
        at hudson.model.AbstractBuild$AbstractBuildExecution.perform(AbstractBuild.java:761)
        at hudson.model.AbstractBuild$AbstractBuildExecution.performAllBuildSteps(AbstractBuild.java:721)
        at hudson.model.Build$BuildExecution.post2(Build.java:183)
        at hudson.model.AbstractBuild$AbstractBuildExecution.post(AbstractBuild.java:670)
        at hudson.model.Run.execute(Run.java:1766)
        at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:43)
        at hudson.model.ResourceController.execute(ResourceController.java:98)
        at hudson.model.Executor.run(Executor.java:374)
    Caused by: java.io.IOException: Truncated TAR archive
        at org.apache.commons.compress.archivers.tar.TarArchiveInputStream.read(TarArchiveInputStream.java:614)
        at java.io.InputStream.read(InputStream.java:101)
        at org.apache.commons.io.IOUtils.copyLarge(IOUtils.java:1792)
        at org.apache.commons.io.IOUtils.copyLarge(IOUtils.java:1769)
        at org.apache.commons.io.IOUtils.copy(IOUtils.java:1744)
        at hudson.util.IOUtils.copy(IOUtils.java:40)
        at hudson.FilePath.readFromTar(FilePath.java:2289)
        ... 13 more
    Build step 'Publish HTML reports' changed build result to FAILURE
    

    After some research and experimentation I was able to resolve this issue. It turned out that the HTML Publisher Plug-in was configured to archive a file that file did not exist. The HTML Publisher Plug-in did not complain, but something broke later on down the line.

    Since the upgrade to Jenkins 1.610, something may have changed in the way that archives are handled by Jenkins, so even though the HTML Publisher Plug-in did not throw an error, somewhere down the line Jenkins is trying to do something with a .tar file. If I remove the configuration that tells the HTML Publisher Plug-in to archive non-existent file platoReport/indexhtml, the build no longer fails. I don't know what's going on behind the scenes, but this was my experience. If you're having similar issues, I urge you to check the build output and ensure that the files expected by the HTML Publisher Plug-in exist. If they don't exist, try removing the configuration for those index pages.

  20. Apr 27

    Farhan Ejaz says:

    I get the following error while installing this plugin on Jenkins version 1.610j...

    I get the following error while installing this plugin on Jenkins version 1.610java.io.IOException: Failed to dynamically deploy this plugin
    at hudson.model.UpdateCenter$InstallationJob._run(UpdateCenter.java:1322)
    at hudson.model.UpdateCenter$DownloadJob.run(UpdateCenter.java:1121)
    at java.util.concurrent.Executors$RunnableAdapter.call(Unknown Source)
    at java.util.concurrent.FutureTask$Sync.innerRun(Unknown Source)
    at java.util.concurrent.FutureTask.run(Unknown Source)
    at hudson.remoting.AtmostOneThreadExecutor$Worker.run(AtmostOneThreadExecutor.java:110)
    at java.lang.Thread.run(Unknown Source)
    Caused by: java.util.zip.ZipException: error in opening zip file
    at java.util.zip.ZipFile.open(Native Method)
    at java.util.zip.ZipFile.<init>(Unknown Source)
    at java.util.zip.ZipFile.<init>(Unknown Source)
    at java.util.jar.JarFile.<init>(Unknown Source)
    at java.util.jar.JarFile.<init>(Unknown Source)
    at hudson.ClassicPluginStrategy.getShortName(ClassicPluginStrategy.java:107)
    at hudson.PluginManager.dynamicLoad(PluginManager.java:438)
    at hudson.model.UpdateCenter$InstallationJob._run(UpdateCenter.java:1318)
    ... 6 more

  21. Apr 27

    Baiyan Huang says:

    Probably a feature request: Could we change the report URL to something unique ...

    Probably a feature request:

    Could we change the report URL to something unique as:

    job/$job_name/htmlreports/$report_name

    This makes the url self-explanary, and also work better with inhertance plugin (which currently doesn't work well with htmlpublisher as the report URL is too general)

  22. Jun 25

    Peter Toennies says:

    The version history lists version 1.4 twice.

    The version history lists version 1.4 twice.