externals:release

Full name:

org.kuali.maven.plugins:externals-maven-plugin:1.0.9-SNAPSHOT:release

Description:

Perform a release of a multi-module Maven project that contains svn:externals. The release process creates a separate tag for each module defined as an svn:external after trimming SNAPSHOT off the version number. It then increments the version number in the root poms and re-appends the SNAPSHOT qualifier before committing the altered poms.

Attributes:

  • Requires a Maven project to be executed.

Optional Parameters

Name Type Since Description
buildNumberProperty String - The property where the current build number is stored. Jenkins automatically sets an environment variable called BUILD_NUMBER each time a job is run
Default value is: env.BUILD_NUMBER.
User property is: externals.buildNumberProperty.
checkoutDir File - The directory where the new tag is checked out to
Default value is: ${project.build.directory}/checkout.
User property is: externals.checkoutDir.
createTagMessage String - The commit message for when the new tag is first created
Default value is: [externals-maven-plugin] Create tag.
User property is: externals.createTagMessage.
externalsMessage String - The commit message for when the svn propset command is used to set externals on the tag
Default value is: [externals-maven-plugin] Set svn:externals.
User property is: externals.externalsMessage.
file File - The location of a text file that contains the svn:externals definitions
Default value is: ${project.build.directory}/checkout/svn.externals.
User property is: externals.file.
ignoreDirectories String - Directories to ignore when examining the file system for Maven pom's
Default value is: src,target,.svn,.git.
User property is: externals.ignoreDirectories.
mappings List - These mappings connect the svn:externals definitions with a property inside the root pom that controls what version each external is set to
pom String - Filename pattern used to discover Maven pom's
Default value is: pom.xml.
User property is: externals.pom.
scmUrlPrefix String - The prefix Maven needs in front of the real SCM url
Default value is: scm:svn:.
User property is: externals.scmUrlPrefix.
updateTagMessage String - The commit message for when the updated pom's and svn.external file is committed to the tag
Default value is: [externals-maven-plugin] Tag maintenance.
User property is: externals.updateTagMessage.

Parameter Details

buildNumberProperty:

The property where the current build number is stored. Jenkins automatically sets an environment variable called BUILD_NUMBER each time a job is run
  • Type: java.lang.String
  • Required: No
  • User Property: externals.buildNumberProperty
  • Default: env.BUILD_NUMBER

checkoutDir:

The directory where the new tag is checked out to
  • Type: java.io.File
  • Required: No
  • User Property: externals.checkoutDir
  • Default: ${project.build.directory}/checkout

createTagMessage:

The commit message for when the new tag is first created
  • Type: java.lang.String
  • Required: No
  • User Property: externals.createTagMessage
  • Default: [externals-maven-plugin] Create tag

externalsMessage:

The commit message for when the svn propset command is used to set externals on the tag
  • Type: java.lang.String
  • Required: No
  • User Property: externals.externalsMessage
  • Default: [externals-maven-plugin] Set svn:externals

file:

The location of a text file that contains the svn:externals definitions
  • Type: java.io.File
  • Required: No
  • User Property: externals.file
  • Default: ${project.build.directory}/checkout/svn.externals

ignoreDirectories:

Directories to ignore when examining the file system for Maven pom's
  • Type: java.lang.String
  • Required: No
  • User Property: externals.ignoreDirectories
  • Default: src,target,.svn,.git

mappings:

These mappings connect the svn:externals definitions with a property inside the root pom that controls what version each external is set to
  • Type: java.util.List
  • Required: No

pom:

Filename pattern used to discover Maven pom's
  • Type: java.lang.String
  • Required: No
  • User Property: externals.pom
  • Default: pom.xml

scmUrlPrefix:

The prefix Maven needs in front of the real SCM url
  • Type: java.lang.String
  • Required: No
  • User Property: externals.scmUrlPrefix
  • Default: scm:svn:

updateTagMessage:

The commit message for when the updated pom's and svn.external file is committed to the tag
  • Type: java.lang.String
  • Required: No
  • User Property: externals.updateTagMessage
  • Default: [externals-maven-plugin] Tag maintenance