git-tag:tag

Full name:

org.honton.chas:git-tag-maven-plugin:0.0.4:tag

Description:

Tag current code with a tagName and message. Optionally use a branch other than HEAD. Unless skipPush is set, the annotated tag is pushed to the origin.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: deploy.

Required Parameters

Name Type Since Description
<tagName> String - Message for the tag
User property is: git.tagName.

Optional Parameters

Name Type Since Description
<branch> String - Git branch (defaults to HEAD branch)
User property is: git.branch.
<message> String - Message for the tag, defaults to "release ${tag}"
User property is: git.message.
<remote> String - Git Remote repository name
Default value is: origin.
User property is: git.remote.
<skip> boolean - Skip executing this plugin
Default value is: false.
User property is: git.skip.
<skipPush> boolean - Skip pushing tag to remote.
Default value is: false.
User property is: git.skipPush.
<skipSnapshots> boolean - Skip creating tag for SNAPSHOTs.
Default value is: true.
User property is: git.skipSnapshots.
<useUseDotSsh> boolean - Use the contents of the ~/.ssh directory instead of ~/.m2/settings.xml to configure ssh connections.
Default value is: false.
User property is: git.use.ssh.

Parameter Details

<branch>

Git branch (defaults to HEAD branch)
  • Type: java.lang.String
  • Required: No
  • User Property: git.branch

<message>

Message for the tag, defaults to "release ${tag}"
  • Type: java.lang.String
  • Required: No
  • User Property: git.message

<remote>

Git Remote repository name
  • Type: java.lang.String
  • Required: No
  • User Property: git.remote
  • Default: origin

<skip>

Skip executing this plugin
  • Type: boolean
  • Required: No
  • User Property: git.skip
  • Default: false

<skipPush>

Skip pushing tag to remote.
  • Type: boolean
  • Required: No
  • User Property: git.skipPush
  • Default: false

<skipSnapshots>

Skip creating tag for SNAPSHOTs.
  • Type: boolean
  • Required: No
  • User Property: git.skipSnapshots
  • Default: true

<tagName>

Message for the tag
  • Type: java.lang.String
  • Required: Yes
  • User Property: git.tagName

<useUseDotSsh>

Use the contents of the ~/.ssh directory instead of ~/.m2/settings.xml to configure ssh connections.
  • Type: boolean
  • Required: No
  • User Property: git.use.ssh
  • Default: false