Generate the semver version using the git commit history and automatically set it to maven pom.

No more manually modifying the pom.xml to decide on the versions.You continue developing and adding commits to your project.When it is time to release, add a commit with a message containinga specific version keyword and watch the magic happen.

• How does it work?
• What are version keywords?
• How to configure?
• How to start with a different version?
• How do I increment version?
• How to change the version pattern?
• How to customize version keywords?
  • Use regex for version keywords
• How to access generated version properties?
• How to create Git tags?
• Contributing
• Acknowledgement

This extension iterates over all the commit history and looks for a predefined keywords representing version changes.It then computes the version number upto current commit.

The extension supports generating Semantic Versionsx.y.z format. The format pattern is configurable to usevalues such as Git hash, branch name etc.

Seemanikmagar/git-versioner-maven-extension-examples for examples of using this extension.

Version keywords are the reserved words that describes which milestone of the release is this.

By default, extension supports following keywords -

• [major] - A Major version milestone Eg. 1.0.0 → 2.0.0

• [minor] - A Minor version milestone Eg. 1.1.0 → 1.2.

• [patch] - A Patch version milestone Eg. 1.1.1 → 1.1.2

To change the keywords, see how toCustomize Version Keywords.

This is a maven build core extension that can -

• Participate in maven build lifecycle

• Automatically set the building project’s version

• No explicit mojo executions needed to set the version

• Project’s POM remain unchanged

To use as a maven build extension,

Create (or modify)extensions.xml file in${project.baseDir}/.mvn/to have the following entry -

See an example test project atgit-versioner-maven-extension/src/test/resources/project-with-extension/.

With just that configuration, next time your project runs any maven goals, you should see version from this moduleis used by Maven reactor. Try runningmvn package on your project.

It is possible that your project is already released with a certain version.In that case, you can configure the initial version to start counting versions from.

You can add following properties to.mvn/git-versioner.extensions.properties file -

With above initial version configuration, the first version calculated by this extension will be -

• Major:2.0.0

• Minor: 1.4.0

• Patch: 1.3.5

Now that you have extension configured, you can continue with your regular development.

When it is time to increment version, you may use one of the following three goalsto add anempty commit with appropriateVersion Keyword -

• git-versioner:commit-major: Adds a git commit with a commit message containingMajor version keyword

• git-versioner:commit-minor: Adds a git commit with a commit message containingMinor version keyword

• git-versioner:commit-patch: Adds a git commit with a commit message containingPatch version keyword

The default message pattern ischore(release): [%k] where[%k] is the keyword token.To change the default message pattern, you could pass-Dgv.commit.message=<message> argument when running the goal.

Off course, you can also add commits manually with appropriate version keywords.

1. where<keyword> can be one of these - major, minor, or patch.

The default version pattern used ismajor.minor.patch(-commit) where(-commit) is skipped if commit count is 0.

This pattern can be canged by setting a property in.mvn/git-versioner.extensions.properties.

The following example will generate versions asmajor.minor.patch+shorthash, eg.1.2.3+a5a29f8.

The defaultversion keywords[major],[minor], and[patch] can be customized by overriding the configuration.

To use different keywords, you can add following properties to.mvn/git-versioner.extensions.properties file -

This extension adds all version properties toMaven properties during build cycle -

You may use these properties in maven pom file, for example as${git.branch} to access git branch name.

You can usegit-versioner:tag goal to create a git tag for current version in local git repository.

For Tag goal, it is possible to configure pom.xml to contain the git-versioner plugin with required execution configuration.

1. If set to not fail, it will just log warning and skip tag creation.

2. Tag name pattern to use. Defaultv%v will result in tags likev1.2.3.

3. Tag message pattern to use. DefaultRelease version %v will add tag message likeRelease version 1.2.3.

All contributions are welcome. Please seeContributing guides.

This is inspired from Gradle plugintoolebox-io/gradle-git-versioner that I have been using for my Gradle projects. This maven plugin is my attempt to get those auto-version capabilities into my Maven builds.