Uploaded image for project: 'Maven Site Plugin'
  1. Maven Site Plugin
  2. MSITE-690

Add new "process-reports" goal

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Won't Do
    • 3.3
    • None
    • None
    • None

    Description

      AFAICT, maven builds a site by relying on other plugins to generate files in a specific HTML format. For example, the PMD and Checkstyle plugins generate reports that include references to @import url("./css/maven-base.css"); and "${project.version}". The site plugin then post-processes these files to do three things:
      (a) add the css files,
      (b) convert references like ${project.version}
      (c) add in a generated menu structure with relative links

      Propose adding a new goal "process-reports" that performs steps (a) and (b) only. Instead of generating the index structure in step (c), it would simply remove the index and header parts of the HTML file to create a simple standalone HTML file.

      The aim of this improvement is to allow valid complete HTML files to be created without the rest of the generated site (with the complications of relative links). This goal would simply run in each project of the multi-module build independently, processing the resources it finds locally.

      Users wanting a checkstyle report could then run "mvn clean checkstyle:checkstyle-aggregator site:process-reports". Today, "mvn clean checkstyle:checkstyle-aggregator" works OK but produces half-complete HTML files.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              scolebourne2 scolebourne2
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: