Skip to content

Sets the maven attribute 'describe' to the current git describe output. Currently directly executes git describe, no JGit implementation yet.

License

Notifications You must be signed in to change notification settings

NandishAndDev/GitDescribe-Maven-Plugin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Git-describe Maven plugin

This plugin invokes git describe and captures the output in a build variable.

Configuration

The plugin might be configured in your pom like so:

  <plugin>
    <groupId>com.lukegb.mojo</groupId>
    <artifactId>gitdescribe-maven-plugin</artifactId>
    <version><!-- Version --></version>
    <executions>
      <execution>
        <goals>
          <goal>gitdescribe</goal>
        </goals>
        <id>git-describe</id>
        <phase>initialize</phase>
        <configuration>
          <!-- configuration properties go here. -->
        </configuration>
      </execution>
    </executions>
  </plugin>

Configuration properties

The following configuration properties are available:

descriptionProperty (Default: describe)
  The name of the build property that will contain the output of git
  describe.

dirty (Default: false)
  If true, pass the `--dirty` flag to git-describe.

dirtyMark (Default: dirty)
  The <mark> value for the `--dirty` parameter.

failOutput (Default: unknown)
  String indicating full output if getting version fails

outputPrefix (Default: git-)
  String to prepend to git describe/shorttag output

outputSuffix
  String to append to git describe/shorttag output.

About

Sets the maven attribute 'describe' to the current git describe output. Currently directly executes git describe, no JGit implementation yet.

Resources

License

Stars

Watchers

Forks

Packages

No packages published