chonton / git-tag-maven-plugin

create git tag from maven plugin

git-tag-maven-plugin

Tag the current head of the local git repository with a tagName and message. This annotated tag is then pushed to a remote repository. The push can optionally be disabled.

The credentials used to authenticate to the remote repository are extracted from the servers section of the maven settings.xml. The particular server credentials are selected by matching the host portion of the git url with a server id.

URL	ServerId
git⁠@github.com:chonton/git-tag-maven-plugin.git	github.com
https⁠://github.com/chonton/git-tag-maven-plugin.git	github.com

The credentials parameters must correlate with the provided url.

URL	Required Credential Parameter(s)
git⁠@github.com:chonton/git-tag-maven-plugin.git	<username> & <password>
ssh git url	<privateKey>

If an ssh git url is provided and you want to use standard ssh configuration from the ~/.ssh directory instead of using ~/.m2/settings.xml, set the useDotSsh parameter to true.

An alternate branch can be specified. An alternate remote repository can also be specified.

Mojo details at plugin info .

The tag goal is by default attached to the deploy phase. This will occur after any packaging type's deploy plugin goal.

The supported parameters are:

Parameter	Required	Property	Default	Description
skip	No	git.skip	false	Skip executing the plugin
tagName	Yes	git.tagName		Tag name
message	No	git.message	release ${tagName}	Tag message
branch	No	git.branch	HEAD	Tag at head of this branch
remote	No	git.remote	origin	Remote repository to push tag to
useDotSsh	No	git.use.ssh	false	Use the contents of ~/.ssh instead of ~/.m2/settings.xml to configure ssh connections
skipPush	No	git.skipPush	false	Skip pushing the tag to remote
skipSnapshots	No	git.skipSnapshots	true	Skip creating tag for snapshots

Typical attached phase use:

  <build>
    <plugins>

      <plugin>
        <groupId>org.honton.chas</groupId>
        <artifactId>git-tag-maven-plugin</artifactId>
        <version>0.0.4</version>
        <executions>
          <execution>
            <goals>
              <goal>tag</goal>
            </goals>
            <configuration>
              <tagName>${version}</tagName>
            </configuration>
          </execution>
        </executions>
      </plugin>

    </plugins>
  </build>

Typical command line use:

mvn org.honton.chas:git-tag-maven-plugin:tag -Dgit.tagName=0.0.1