maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Hervé Boutemy (JIRA) <j...@apache.org>
Subject [jira] [Updated] (MSITE-690) Add new "process-reports" goal
Date Sun, 20 Dec 2015 03:24:46 GMT

     [ https://issues.apache.org/jira/browse/MSITE-690?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Hervé Boutemy updated MSITE-690:
--------------------------------
    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.


  was:
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.



> Add new "process-reports" goal
> ------------------------------
>
>                 Key: MSITE-690
>                 URL: https://issues.apache.org/jira/browse/MSITE-690
>             Project: Maven Site Plugin
>          Issue Type: Improvement
>    Affects Versions: 3.3
>            Reporter: scolebourne2
>
> 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.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message