Apache Commons logo
Apache Commons Build Plugin Maven Mojo ™
  • Last Published: 09 November 2024
  • |
  • Version: 1.14.1

commons-build:all

Full name:

org.apache.commons:commons-build-plugin:1.14.1:all

Description:

Apache Commons Build Mojo: Generate all pages.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Is NOT inherited by default in multi-project builds.

Required Parameters

Name Type Since Description
<commons.jira.id> String - The external JIRA id for the project (alphabetic, upper case.)
Default: ${commons.jira.id}
<commons.jira.pid> String - The internal JIRA id for the project (numeric.)
Default: ${commons.jira.pid}
<commons.release.version> String - The version of the latest release of the project.
Default: ${commons.release.version}
<commons.release.name> String - The name of the latest release of the project.
Default: ${commons.release.name}
<commons.release.2.name> String - The name of the alternative release of the project.
Default: ${commons.release.2.name}
<commons.release.3.name> String - The name of the alternative release of the project.
Default: ${commons.release.3.name}
<commons.release.4.name> String - The name of the alternative release of the project.
Default: ${commons.release.4.name}
<basedir> File - The base directory from which to execute the Ant script.
Default: ${basedir}
User Property: antBasedir
Alias: ant.basedir

Optional Parameters

Name Type Since Description
<commons.dist.subdir> String - The folder in commons for this component.
Default: ${commons.dist.subdir}
<commons.binary.suffix> String - The suffix for the binary distribution.
Default: ${commons.binary.suffix}
<commons.release.desc> String - Release Title or Description.
Default: ${commons.release.desc}
<commons.release.subdir> String - Subdirectory (instead of source/binaries.)
Default: ${commons.release.subdir}
<commons.release.hash> String - Type of hash (lower case, e.g. sha512)
Default: ${commons.release.hash}
<commons.release.2.version> String - The version of an alternative release of the project.
Default: ${commons.release.2.version}
<commons.release.2.desc> String - Alternative Release Title or Description.
Default: ${commons.release.2.desc}
<commons.release.2.binary.suffix> String - The suffix for the alternative release binary distribution.
Default: ${commons.release.2.binary.suffix}
<commons.release.2.subdir> String - Subdirectory (instead of source/binaries.)
Default: ${commons.release.2.subdir}
<commons.release.2.hash> String - Type of hash (lower case, e.g. sha512)
Default: ${commons.release.2.hash}
<commons.release.3.version> String - The version of an alternative release of the project.
Default: ${commons.release.3.version}
<commons.release.3.desc> String - Alternative Release Title or Description.
Default: ${commons.release.3.desc}
<commons.release.3.binary.suffix> String - The suffix for the alternative release binary distribution.
Default: ${commons.release.3.binary.suffix}
<commons.release.3.subdir> String - Subdirectory (instead of source/binaries.)
Default: ${commons.release.3.subdir}
<commons.release.3.hash> String - Type of hash (lower case, e.g. sha512)
Default: ${commons.release.3.hash}
<commons.release.4.version> String - The version of an alternative release of the project.
Default: ${commons.release.4.version}
<commons.release.4.desc> String - Alternative Release Title or Description.
Default: ${commons.release.4.desc}
<commons.release.4.binary.suffix> String - The suffix for the alternative release binary distribution.
Default: ${commons.release.4.binary.suffix}
<commons.release.4.subdir> String - Subdirectory (instead of source/binaries.)
Default: ${commons.release.4.subdir}
<commons.release.4.hash> String - Type of hash (lower case, e.g. sha512)
Default: ${commons.release.4.hash}
<messageLevel> String - The message-level used to tune the verbosity of Ant logging.
Default: info
User Property: antMessageLevel
Alias: ant.messageLevel

Parameter Details

<commons.jira.id>

The external JIRA id for the project (alphabetic, upper case.)
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.jira.id}

<commons.dist.subdir>

The folder in commons for this component.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.dist.subdir}

<commons.jira.pid>

The internal JIRA id for the project (numeric.)
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.jira.pid}

<commons.release.version>

The version of the latest release of the project.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.release.version}

<commons.release.name>

The name of the latest release of the project.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.release.name}

<commons.binary.suffix>

The suffix for the binary distribution.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.binary.suffix}

<commons.release.desc>

Release Title or Description.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.desc}

<commons.release.subdir>

Subdirectory (instead of source/binaries.)
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.subdir}

<commons.release.hash>

Type of hash (lower case, e.g. sha512)
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.hash}

<commons.release.2.version>

The version of an alternative release of the project.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.2.version}

<commons.release.2.name>

The name of the alternative release of the project.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.release.2.name}

<commons.release.2.desc>

Alternative Release Title or Description.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.2.desc}

<commons.release.2.binary.suffix>

The suffix for the alternative release binary distribution.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.2.binary.suffix}

<commons.release.2.subdir>

Subdirectory (instead of source/binaries.)
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.2.subdir}

<commons.release.2.hash>

Type of hash (lower case, e.g. sha512)
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.2.hash}

<commons.release.3.version>

The version of an alternative release of the project.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.3.version}

<commons.release.3.name>

The name of the alternative release of the project.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.release.3.name}

<commons.release.3.desc>

Alternative Release Title or Description.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.3.desc}

<commons.release.3.binary.suffix>

The suffix for the alternative release binary distribution.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.3.binary.suffix}

<commons.release.3.subdir>

Subdirectory (instead of source/binaries.)
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.3.subdir}

<commons.release.3.hash>

Type of hash (lower case, e.g. sha512)
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.3.hash}

<commons.release.4.version>

The version of an alternative release of the project.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.4.version}

<commons.release.4.name>

The name of the alternative release of the project.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.release.4.name}

<commons.release.4.desc>

Alternative Release Title or Description.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.4.desc}

<commons.release.4.binary.suffix>

The suffix for the alternative release binary distribution.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.4.binary.suffix}

<commons.release.4.subdir>

Subdirectory (instead of source/binaries.)
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.4.subdir}

<commons.release.4.hash>

Type of hash (lower case, e.g. sha512)
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.4.hash}

<basedir>

The base directory from which to execute the Ant script.
  • Type: java.io.File
  • Required: Yes
  • User Property: antBasedir
  • Default: ${basedir}
  • Alias: ant.basedir

<messageLevel>

The message-level used to tune the verbosity of Ant logging.
  • Type: java.lang.String
  • Required: No
  • User Property: antMessageLevel
  • Default: info
  • Alias: ant.messageLevel

Copyright © 2008-2024 The Apache Software Foundation. All Rights Reserved.

Apache Commons, Apache Commons Build Plugin Maven Mojo, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.