Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-18154

HTML output directory is incorrect when folderWhereYouRunDoxygen is used

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      When the "folder where you run Doxygen" setting is used, the HTML_OUTPUT setting in the Doxyfile is interpreted relative to that location, instead of being relative to the OUTPUT_DIRECTORY setting (which itself is relative to the folderWhereYouRunDoxygen). This causes publication of the generated documentation to fail.

        Attachments

          Activity

          kbriggs Kieron Briggs created issue -
          Hide
          kbriggs Kieron Briggs added a comment -
          Show
          kbriggs Kieron Briggs added a comment - Patch submission: https://github.com/jenkinsci/doxygen-plugin/pull/5
          kbriggs Kieron Briggs made changes -
          Field Original Value New Value
          Assignee Kieron Briggs [ kbriggs ] Gregory Boissinot [ gbois ]
          Hide
          scm_issue_link SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Kieron Briggs
          Path:
          src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java
          src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java
          http://jenkins-ci.org/commit/doxygen-plugin/b5cf9da892100519873bbad5911659d1f3c6e672
          Log:
          JENKINS-18154 Use correct HTML output with folderWhereYouRunDoxygen

          Show
          scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Kieron Briggs Path: src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java http://jenkins-ci.org/commit/doxygen-plugin/b5cf9da892100519873bbad5911659d1f3c6e672 Log: JENKINS-18154 Use correct HTML output with folderWhereYouRunDoxygen
          Hide
          scm_issue_link SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Gregory Boissinot
          Path:
          src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java
          src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java
          http://jenkins-ci.org/commit/doxygen-plugin/8a61bf917a5b9fe9cd669d4fcdc3966965e4198c
          Log:
          Merge pull request #5 from kbriggs/bugfix-JENKINS-18154

          JENKINS-18154 Use correct HTML output with folderWhereYouRunDoxygen

          Compare: https://github.com/jenkinsci/doxygen-plugin/compare/e05b4e9fdc8c...8a61bf917a5b

          Show
          scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Gregory Boissinot Path: src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java http://jenkins-ci.org/commit/doxygen-plugin/8a61bf917a5b9fe9cd669d4fcdc3966965e4198c Log: Merge pull request #5 from kbriggs/bugfix- JENKINS-18154 JENKINS-18154 Use correct HTML output with folderWhereYouRunDoxygen Compare: https://github.com/jenkinsci/doxygen-plugin/compare/e05b4e9fdc8c...8a61bf917a5b
          gbois Gregory Boissinot made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]
          Hide
          s7726 Gavin Swanson added a comment -

          This was the only thing listed as changed between 0.11 and 0.12 The 0.12 version broke our build.

          Publishing Doxygen HTML results.
          FATAL: error
          hudson.AbortException: The output directory doesn't exist.
          at hudson.plugins.doxygen.DoxygenDirectoryParser.retrieveDoxygenDirectoryFromDoxyfile(DoxygenDirectoryParser.java:350)
          at hudson.plugins.doxygen.DoxygenDirectoryParser.invoke(DoxygenDirectoryParser.java:53)
          at hudson.plugins.doxygen.DoxygenDirectoryParser.invoke(DoxygenDirectoryParser.java:14)
          at hudson.FilePath.act(FilePath.java:905)
          at hudson.FilePath.act(FilePath.java:878)
          at hudson.plugins.doxygen.DoxygenArchiver._perform(DoxygenArchiver.java:219)
          at hudson.plugins.doxygen.DoxygenArchiver.perform(DoxygenArchiver.java:176)
          at hudson.tasks.BuildStepMonitor$2.perform(BuildStepMonitor.java:27)
          at hudson.model.AbstractBuild$AbstractBuildExecution.perform(AbstractBuild.java:804)
          at hudson.model.AbstractBuild$AbstractBuildExecution.performAllBuildSteps(AbstractBuild.java:776)
          at hudson.model.Build$BuildExecution.post2(Build.java:183)
          at hudson.model.AbstractBuild$AbstractBuildExecution.post(AbstractBuild.java:726)
          at hudson.model.Run.execute(Run.java:1601)
          at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:46)
          at hudson.model.ResourceController.execute(ResourceController.java:88)
          at hudson.model.Executor.run(Executor.java:241)
          Build step 'Publish Doxygen' changed build result to FAILURE

          Show
          s7726 Gavin Swanson added a comment - This was the only thing listed as changed between 0.11 and 0.12 The 0.12 version broke our build. Publishing Doxygen HTML results. FATAL: error hudson.AbortException: The output directory doesn't exist. at hudson.plugins.doxygen.DoxygenDirectoryParser.retrieveDoxygenDirectoryFromDoxyfile(DoxygenDirectoryParser.java:350) at hudson.plugins.doxygen.DoxygenDirectoryParser.invoke(DoxygenDirectoryParser.java:53) at hudson.plugins.doxygen.DoxygenDirectoryParser.invoke(DoxygenDirectoryParser.java:14) at hudson.FilePath.act(FilePath.java:905) at hudson.FilePath.act(FilePath.java:878) at hudson.plugins.doxygen.DoxygenArchiver._perform(DoxygenArchiver.java:219) at hudson.plugins.doxygen.DoxygenArchiver.perform(DoxygenArchiver.java:176) at hudson.tasks.BuildStepMonitor$2.perform(BuildStepMonitor.java:27) at hudson.model.AbstractBuild$AbstractBuildExecution.perform(AbstractBuild.java:804) at hudson.model.AbstractBuild$AbstractBuildExecution.performAllBuildSteps(AbstractBuild.java:776) at hudson.model.Build$BuildExecution.post2(Build.java:183) at hudson.model.AbstractBuild$AbstractBuildExecution.post(AbstractBuild.java:726) at hudson.model.Run.execute(Run.java:1601) at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:46) at hudson.model.ResourceController.execute(ResourceController.java:88) at hudson.model.Executor.run(Executor.java:241) Build step 'Publish Doxygen' changed build result to FAILURE
          s7726 Gavin Swanson made changes -
          Resolution Fixed [ 1 ]
          Status Resolved [ 5 ] Reopened [ 4 ]
          Hide
          kbriggs Kieron Briggs added a comment -

          Gavin, are you able to share your full Doxygen post-build task configuration, and the OUTPUT_DIRECTORY and HTML_OUTPUT lines from the Doxyfile? It's possible my patch didn't cover all possible combinations. 

          Show
          kbriggs Kieron Briggs added a comment - Gavin, are you able to share your full Doxygen post-build task configuration, and the OUTPUT_DIRECTORY and HTML_OUTPUT lines from the Doxyfile? It's possible my patch didn't cover all possible combinations. 
          Hide
          s7726 Gavin Swanson added a comment -

          Publish Doxygen

          Doxyfile path Documentation/config.doxyfile
          Retain doxygen generation for each successful build Not Checked
          Folder from which doxygen is run Documentation

          OUTPUT_DIRECTORY = .
          HTML_OUTPUT = html

          I would imagine it's choking on the html directory not existing. Maybe add a check that the directory exists and create it if not?

          Show
          s7726 Gavin Swanson added a comment - Publish Doxygen Doxyfile path Documentation/config.doxyfile Retain doxygen generation for each successful build Not Checked Folder from which doxygen is run Documentation OUTPUT_DIRECTORY = . HTML_OUTPUT = html I would imagine it's choking on the html directory not existing. Maybe add a check that the directory exists and create it if not?
          Hide
          kbriggs Kieron Briggs added a comment -
          Show
          kbriggs Kieron Briggs added a comment - New patch submission: https://github.com/jenkinsci/doxygen-plugin/pull/6
          Hide
          scm_issue_link SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Kieron Briggs
          Path:
          src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java
          http://jenkins-ci.org/commit/doxygen-plugin/730f19870fc64dc710bd2b8321f535410e623c01
          Log:
          JENKINS-18154 Refactor getDoxygenGeneratedDir() to use FilePath

          Using the FilePath abstraction instead of concatenating path strings
          simplifies the logic substantially; it no longer matters whether the
          path is relative or absolute, for example.

          Show
          scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Kieron Briggs Path: src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java http://jenkins-ci.org/commit/doxygen-plugin/730f19870fc64dc710bd2b8321f535410e623c01 Log: JENKINS-18154 Refactor getDoxygenGeneratedDir() to use FilePath Using the FilePath abstraction instead of concatenating path strings simplifies the logic substantially; it no longer matters whether the path is relative or absolute, for example.
          Hide
          scm_issue_link SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Kieron Briggs
          Path:
          src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java
          src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java
          src/test/java/hudson/plugins/doxygen/DoxygenDirectoryParserTest.java
          http://jenkins-ci.org/commit/doxygen-plugin/f9b10f47eac5609d3419240831f80bd6083bb3c3
          Log:
          JENKINS-18154 remove isDirectoryAbsolute()

          The refactor of getDoxygenGeneratedDir() has made isDirectoryAbsolute()
          redundant; remove it.

          Show
          scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Kieron Briggs Path: src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java src/test/java/hudson/plugins/doxygen/DoxygenDirectoryParserTest.java http://jenkins-ci.org/commit/doxygen-plugin/f9b10f47eac5609d3419240831f80bd6083bb3c3 Log: JENKINS-18154 remove isDirectoryAbsolute() The refactor of getDoxygenGeneratedDir() has made isDirectoryAbsolute() redundant; remove it.
          Hide
          scm_issue_link SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Kieron Briggs
          Path:
          src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java
          src/test/resources/hudson/plugins/doxygen/Doxyfile-dot
          http://jenkins-ci.org/commit/doxygen-plugin/7943ee7971676e8b8c44ac9acfb9729d026dfc25
          Log:
          JENKINS-18154 Add test for OUTPUT_DIRECTORY=.

          Show
          scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Kieron Briggs Path: src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java src/test/resources/hudson/plugins/doxygen/Doxyfile-dot http://jenkins-ci.org/commit/doxygen-plugin/7943ee7971676e8b8c44ac9acfb9729d026dfc25 Log: JENKINS-18154 Add test for OUTPUT_DIRECTORY=.
          Hide
          scm_issue_link SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Gregory Boissinot
          Path:
          src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java
          src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java
          src/test/java/hudson/plugins/doxygen/DoxygenDirectoryParserTest.java
          src/test/resources/hudson/plugins/doxygen/Doxyfile-dot
          http://jenkins-ci.org/commit/doxygen-plugin/171a66a82dacd93a1038fea4be34295067408cbc
          Log:
          Merge pull request #6 from kbriggs/bugfix-JENKINS-18154

          JENKINS-18154 Use correct HTML output with folderWhereYouRunDoxygen

          Compare: https://github.com/jenkinsci/doxygen-plugin/compare/e39037fd930c...171a66a82dac

          Show
          scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Gregory Boissinot Path: src/main/java/hudson/plugins/doxygen/DoxygenDirectoryParser.java src/test/java/hudson/plugins/doxygen/DoxygenArchiverTest.java src/test/java/hudson/plugins/doxygen/DoxygenDirectoryParserTest.java src/test/resources/hudson/plugins/doxygen/Doxyfile-dot http://jenkins-ci.org/commit/doxygen-plugin/171a66a82dacd93a1038fea4be34295067408cbc Log: Merge pull request #6 from kbriggs/bugfix- JENKINS-18154 JENKINS-18154 Use correct HTML output with folderWhereYouRunDoxygen Compare: https://github.com/jenkinsci/doxygen-plugin/compare/e39037fd930c...171a66a82dac
          gbois Gregory Boissinot made changes -
          Status Reopened [ 4 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]
          rtyler R. Tyler Croy made changes -
          Workflow JNJira [ 149452 ] JNJira + In-Review [ 193132 ]

            People

            • Assignee:
              gbois Gregory Boissinot
              Reporter:
              kbriggs Kieron Briggs
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: