externals:tag

Full name:

org.kuali.maven.plugins:externals-maven-plugin:1.0.4:tag

Description:

Connect svn:externals definitions with a multi-module Maven build in an intelligent manner. This mojo creates a tag from a Subversion checkout containing svn:externals definitions that correspond to Maven modules. The version numbers in the respective poms are modified to reflect the current build. This allows the tag to be used to create reproducible builds. The binaries Maven produces off the tag, correspond exactly to the version numbers in the Maven pom's.

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.
checkoutDir File - The directory where the new tag is checked out to
Default value is: ${project.build.directory}/checkout.
createTagMessage String - The commit message for when the new tag is first created
Default value is: [externals-maven-plugin] Create tag.
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.
file File - The location of a text file that contains the svn:externals definitions
Default value is: ${project.build.directory}/checkout/svn.externals.
ignoreDirectories String - Directories to ignore when examining the file system for Maven pom's
Default value is: src,target,.svn,.git.
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.
scmUrlPrefix String - The prefix Maven needs in front of the real SCM url
Default value is: scm:svn:.
tagStyle TagStyle - Either BUILDNUMBER, REVISION, or RELEASE
Default value is: BUILDNUMBER.
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.

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
  • Expression: ${externals.buildNumberProperty}
  • Default: env.BUILD_NUMBER

checkoutDir:

The directory where the new tag is checked out to
  • Type: java.io.File
  • Required: No
  • Expression: ${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
  • Expression: ${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
  • Expression: ${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
  • Expression: ${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
  • Expression: ${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
  • Expression: ${externals.pom}
  • Default: pom.xml

scmUrlPrefix:

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

tagStyle:

Either BUILDNUMBER, REVISION, or RELEASE
  • Type: org.kuali.maven.plugins.externals.TagStyle
  • Required: No
  • Expression: ${externals.tagStyle}
  • Default: BUILDNUMBER

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
  • Expression: ${externals.updateTagMessage}
  • Default: [externals-maven-plugin] Tag maintenance