commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jörg Schaible <joerg.schai...@swisspost.com>
Subject Re: [ALL] Commons Parent - additional minimal site building profile?
Date Tue, 20 Jan 2015 09:44:41 GMT
Hi Sebb,

sebb wrote:

> Building the full site for a component can be quite time-consuming,
> which makes checking the documentation build tedious.
> 
> Almost all the reports have "skip" parameters, so it's possible to
> build up a command that only builds the component docs. This can be
> saved as a shell script or alias. (Or define a profile in
> settings.xml)
> But those won't be available on other systems - or to other users.
> 
> Just wondering whether anyone else would find it useful to have an
> (optional) profile for this?
> 
> For example, I have an alias:
> 
> mvnsite='mvn site -DskipTests -Dmaven.javadoc.skip -Dmaven.clover.skip
> -Dcobertura.skip -Dfindbugs.skip -Dcheckstyle.skip -Dclirr.skip
> -Dchanges.jira.skip'
> 
> It would be possible to define these props in a profile, for example
> "basic" (or "docsonly" ?)
> 
> mvn site -Pbasic
> 
> This would then create a basic site without all the additional reports.
> 
> If a particular report was needed, that would be possible too:
> 
> mvn site -Pbasic -Dclirr.skip=false
> 
> Just a thought.

A profile is perfect. We can introduce a skip property for every type and 
set all of them in the profile to false:

========== %< =========
 <profiles>
   <profile>
     <id>basic</id>
     <properties>
       <commons.skip.tests>true</commons.skip.tests>
       ...
     </properties>
   </profile>
 </profiles>
 <pluginManagement>
   <plugins>
     <plugin>
       <-- surefire G:A:V -->
       <configuration>
         <maven.test.skip.exec>${commons.skip.tests}</maven.test.skip.exec>
       </configuration>
     </plugin>
     ...
   </plugins>
 </pluginManagement>
 <properties>
   <commons.skip.tests>false</commons.skip.tests>
   ...
 </properties>
========== %< =========

Additionally we get the advantage to run or skip individual stuff from 
command line with identical pattern for the properties (or do you remember 
every time the individual property names):

 mvn site -Dcommons.skip.clirr=true

 mvn site -Pbasic -Dcommons.skip.clirr=false


+1

Cheers,
Jörg


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message