helper:compute-distribution-site-url

Full name:

org.nuiton:helper-maven-plugin:2.3.2:compute-distribution-site-url

Description:

To compute distribution site url distinguising url when project version is a snapshot. Created on 27/02/16.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 2.3.
  • Binds by default to the lifecycle phase: pre-site.
  • Requires that Maven runs in online mode.

Required Parameters

Name Type Since Description
distributionSiteUrlPrefix String 2.3 Site deploy classifier to use when project's version is a snapshot.
Default value is: scpexe://forge.nuiton.org/var/lib/doc/maven-site/${platform}/${projectId}.
User property is: helper.distributionSiteUrlPrefix.
releaseSiteDeployClassifier String 2.3 Site deploy classifier to use when project's version is not a snapshot.
Default value is: ${project.version}.
User property is: helper.releaseSiteDeployClassifier.
snapshotSiteDeployClassifier String 2.3 Site deploy classifier to use when project's version is a snapshot.
Default value is: develop.
User property is: helper.snapshotSiteDeployClassifier.

Optional Parameters

Name Type Since Description
verbose boolean 2.3 A flag to activate verbose mode.
Default value is: ${maven.verbose}.
User property is: helper.verbose.

Parameter Details

distributionSiteUrlPrefix:

Site deploy classifier to use when project's version is a snapshot.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • User Property: helper.distributionSiteUrlPrefix
  • Default: scpexe://forge.nuiton.org/var/lib/doc/maven-site/${platform}/${projectId}

releaseSiteDeployClassifier:

Site deploy classifier to use when project's version is not a snapshot.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • User Property: helper.releaseSiteDeployClassifier
  • Default: ${project.version}

snapshotSiteDeployClassifier:

Site deploy classifier to use when project's version is a snapshot.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • User Property: helper.snapshotSiteDeployClassifier
  • Default: develop

verbose:

A flag to activate verbose mode.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: helper.verbose
  • Default: ${maven.verbose}