Fork me on GitHub
Built by Maven

siteskinner:skin

Full name:

org.codehaus.mojo:siteskinner-maven-plugin:1.1-SNAPSHOT:skin

Description:

Call mvn siteskinner:skin on a maven project. This will check out the latest releases project. Next it will add/replace the skin of the site.xml with the skin of the current project. Finally it will invoke a mvn site on the checked out project. Now you can verify the pages and run mvn site:deploy on the checked out project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Executes by direct invocation only.

Optional Parameters

Name Type Since Description
<arguments> String 1.1 Addition arguments, accepts:
  • -D,--define <arg>
  • -P,--activate-profiles <arg>
  • -X,--debug

User property is: arguments.
<forceCheckout> boolean 1.0 Force a checkout instead of an update when the sources have already been checked out during a previous run.
Default value is: false.
User property is: forceCheckout.
<inputEncoding> String 1.0 Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
<mavenHome> File 1.1 Some versions of the maven-site-plugin require a specific Maven version. This check is done by the siteskinner. You can fork the execution of the site generation to another version of maven by setting the mavenHome
Maven Site Plugin version Required Maven version
(,3.0-alpha-1) 2.x
[3.0-alpha-1,3.0) 3.x
[3.0,) 2.x or 3.x

User property is: mavenHome.
<mergeBody> boolean 1.0 If true, all the elements of the body in the site.xml will be merged, except the menu items. Set to if you don't want to merge the body.
Default value is: true.
User property is: mergeBody.
<outputEncoding> String 1.0 Specifies the output encoding.
Default value is: ${project.reporting.outputEncoding}.
User property is: outputEncoding.
<publishDate> String 1.1 In most cases this plugin can discover the original publishDate. You could set this value for those cases when this fails
User property is: siteskinner.publishDate.
<settingsFile> File 1.0 (no description)
User property is: settingsFile.
<siteDeploy> boolean 1.0 If false the plugin should only generate the site, else if true the site should be published immediately too.
Default value is: false.
User property is: siteDeploy.

Parameter Details

<arguments>

Addition arguments, accepts:
  • -D,--define <arg>
  • -P,--activate-profiles <arg>
  • -X,--debug
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: arguments

<forceCheckout>

Force a checkout instead of an update when the sources have already been checked out during a previous run.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: forceCheckout
  • Default: false

<inputEncoding>

Specifies the input encoding.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

<mavenHome>

Some versions of the maven-site-plugin require a specific Maven version. This check is done by the siteskinner. You can fork the execution of the site generation to another version of maven by setting the mavenHome
Maven Site Plugin version Required Maven version
(,3.0-alpha-1) 2.x
[3.0-alpha-1,3.0) 3.x
[3.0,) 2.x or 3.x
  • Type: java.io.File
  • Since: 1.1
  • Required: No
  • User Property: mavenHome

<mergeBody>

If true, all the elements of the body in the site.xml will be merged, except the menu items. Set to if you don't want to merge the body.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: mergeBody
  • Default: true

<outputEncoding>

Specifies the output encoding.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

<publishDate>

In most cases this plugin can discover the original publishDate. You could set this value for those cases when this fails
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: siteskinner.publishDate

<settingsFile>

(no description)
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • User Property: settingsFile

<siteDeploy>

If false the plugin should only generate the site, else if true the site should be published immediately too.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: siteDeploy
  • Default: false