Apache Commons logo

commons-release:compress-site

Full name:

org.apache.commons:commons-release-plugin:1.7:compress-site

This plugin goal has been deprecated:

- as we no longer wish to compress the site, we are going to put this functionality in the CommonsDistributionStagingMojo.

Description:

Takes the built ./target/site directory and compresses it to ./target/commons-release-plugin/site.zip.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: post-site.

Optional Parameters

Name Type Since Description
<distSvnStagingUrl> String 1.0 The url of the subversion repository to which we wish the artifacts to be staged. Typicallly this would need to be of the form: scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo. Note. that the prefix to the substring https is a requirement.
User property is: commons.distSvnStagingUrl.
<isDistModule> Boolean 1.0 A parameter to generally avoid running unless it is specifically turned on by the consuming module.
Default value is: false.
User property is: commons.release.isDistModule.
<siteDirectory> File 1.0 (no description)
Default value is: ${project.build.directory}/site.
User property is: commons.siteOutputDirectory.
<workingDirectory> File 1.0 The working directory for the plugin which, assuming the maven uses the default ${project.build.directory}, this becomes target/commons-release-plugin.
Default value is: ${project.build.directory}/commons-release-plugin.
User property is: commons.outputDirectory.

Parameter Details

<distSvnStagingUrl>

The url of the subversion repository to which we wish the artifacts to be staged. Typicallly this would need to be of the form: scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo. Note. that the prefix to the substring https is a requirement.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: commons.distSvnStagingUrl

<isDistModule>

A parameter to generally avoid running unless it is specifically turned on by the consuming module.
  • Type: java.lang.Boolean
  • Since: 1.0
  • Required: No
  • User Property: commons.release.isDistModule
  • Default: false

<siteDirectory>

(no description)
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • User Property: commons.siteOutputDirectory
  • Default: ${project.build.directory}/site

<workingDirectory>

The working directory for the plugin which, assuming the maven uses the default ${project.build.directory}, this becomes target/commons-release-plugin.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • User Property: commons.outputDirectory
  • Default: ${project.build.directory}/commons-release-plugin