collabnet:deploy-to-releases

Full name:

com.maestrodev:collabnet-maven-plugin:1.1:deploy-to-releases

Description:

Deploy the project's artifacts to the CollabNet File Releases section.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: deploy.

Required Parameters

Name Type Since Description
createRelease boolean - Whether to create the release on CollabNet if it does not already exist.
Default value is: true.
pkg String - The package (product) to deploy the files to. If it can not be found, it will be created, unless createRelease is false.
Default value is: ${project.name}.
project String - The name of the CollabNet TeamForge project to deploy the files to.
release String - The name of the release to deploy the files to. If it can not be found it will be created, unless createRelease is false.
Default value is: ${project.version}.
teamForgeUrl String - The URL of the TeamForge instance to deploy to.

Optional Parameters

Name Type Since Description
overwrite Boolean - Whether to overwrite the file if it already exists. The default is true if the project version is a snapshot and false if it is a release.
packageDescription String - The description to assign to the package, if it is created.
Default value is: ${project.description}.
releaseDescription String - The description to assign to the release, if it is created.
releaseMaturity String - The maturity to assign to the release, if it is created.
releaseStatus String - The status to assign to the release, if it is created. The default is to set it to active if the project version is a release, and pending if the project version is a snapshot.
teamForgePassword String - The password to login to TeamForge with. Required if teamForgeServerId is not specified.
teamForgeServerId String - The server ID in settings.xml for retrieving the username and password from.
Default value is: teamforge.
teamForgeUsername String - The username to login to TeamForge with. Required if teamForgeServerId is not specified.

Parameter Details

createRelease:

Whether to create the release on CollabNet if it does not already exist.
  • Type: boolean
  • Required: Yes
  • Default: true

overwrite:

Whether to overwrite the file if it already exists. The default is true if the project version is a snapshot and false if it is a release.
  • Type: java.lang.Boolean
  • Required: No

packageDescription:

The description to assign to the package, if it is created.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.description}

pkg:

The package (product) to deploy the files to. If it can not be found, it will be created, unless createRelease is false.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.name}

project:

The name of the CollabNet TeamForge project to deploy the files to.
  • Type: java.lang.String
  • Required: Yes

release:

The name of the release to deploy the files to. If it can not be found it will be created, unless createRelease is false.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.version}

releaseDescription:

The description to assign to the release, if it is created.
  • Type: java.lang.String
  • Required: No

releaseMaturity:

The maturity to assign to the release, if it is created.
  • Type: java.lang.String
  • Required: No

releaseStatus:

The status to assign to the release, if it is created. The default is to set it to active if the project version is a release, and pending if the project version is a snapshot.
  • Type: java.lang.String
  • Required: No

teamForgePassword:

The password to login to TeamForge with. Required if teamForgeServerId is not specified.
  • Type: java.lang.String
  • Required: No

teamForgeServerId:

The server ID in settings.xml for retrieving the username and password from.
  • Type: java.lang.String
  • Required: No
  • Default: teamforge

teamForgeUrl:

The URL of the TeamForge instance to deploy to.
  • Type: java.lang.String
  • Required: Yes

teamForgeUsername:

The username to login to TeamForge with. Required if teamForgeServerId is not specified.
  • Type: java.lang.String
  • Required: No