git-commit-id-plugin is a plugin quite similar to https://fisheye.codehaus.org/browse/mojo/tags/buildnumber-maven-plugin-1.0-beta-4 for example but as buildnumber at the time when I started this plugin only supported CVS and SVN, something had to be done. I had to quickly develop an git version of such a plugin. For those who don't know the previous plugins, it basically helps you to help you with the following tasks and answer related questions
- Which version had the bug? Is that deployed already?
- Make your distributed deployment aware of versions
- Validate if properties are set as expected
If you are more interested in the different use-cases, feel free to read about them in more detail.
- Use case documentation
- Using the plugin documentation (all details for configuration, properties, ...)
- A more technical documentation on how to use the leverage the generated properties from this plugin
- A general documentation for git describe (usefull feature in this plugin, if you are not familiar with the command)
- Frequently Asked Question (FAQ)
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin.
A detailed description of using the plugin is available in the Using the plugin section. All you need to do in the basic setup is to include that plugin definition in your pom.xml.
For more advanced users we also prepared a guide to provide a brief overview of the more advanced configurations... read on!
The current version is 4.0.0 (changelist).
You can check the available versions by visiting search.maven.org, though using the newest is obviously the best choice.
| Plugin Version | Required Java Version |
|---|---|
| 2.1.X | Java 1.6 |
| 2.2.X | Java 1.7 |
| 3.0.0 | Java 1.8 |
Even though this plugin tries to be compatible with every Maven version there are some known limitations with specific versions. Here is a list that tries to outline the current state of the art:
| Maven Version | Plugin Version | Notes |
|---|---|---|
| Maven 3.1.0 (and below) | up to 2.1.13 | |
| Maven 3.1.1 (and onwards) | any | |
| Maven 3.0 (and onwards) | from 2.2.4 | With Maven 3.0.X SLF4J fails to load class "org.slf4j.impl.StaticLoggerBinder". |
| Maven 3.3.1 | any | plugin version 2.1.14 doesn't work |
| Maven 3.3.3 | any | plugin version 2.1.14 doesn't work |
Starting with Maven 3.1.1 any plugin version is currently compatible. Only known exception is for Maven 3.3.1 and Maven 3.3.3 where the plugin version 2.1.14 is not working properly.
If you really want to use snapshots, here's the repository they are deployed to. But I highly recommend using only stable versions, from maven central... :-)
<pluginRepositories>
<pluginRepository>
<id>sonatype-snapshots</id>
<name>Sonatype Snapshots</name>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</pluginRepository>
</pluginRepositories>If you just would like to see what the plugin can do, you can clone the repository and run
mvn clean install -Dmaven.test.skip=true && mvn clean package -Pdemo -Dmaven.test.skip=true
This project is currently maintained thanks to: @ktoso (founder), @TheSnoozer
I'd like to give a big thanks to some of these folks, for their suggestions and / or pull requests that helped make this plugin as popular as it is today:
- @mostr - for bugfixes and a framework to do integration testing,
- @fredcooke - for consistent feedback and suggestions,
- @MrOnion - for a small yet fast bugfix,
- @cardil and @TheSnoozer - for helping with getting the native git support shipped,
- all the other contributors (as of writing 50) which can be on the contributors tab - thanks guys,
- ... many others - thank you for your contributions,
- ... you! - for using the plugin :-)
- neo4j – graph database
- foundationdb – another open source database
- Spring Boot – yes, the upstream Spring project is using us
- Akamai, Sabre, EasyDITA, and many many others,
- many others I don't know of.
I'm releasing this plugin under the GNU Lesser General Public License 3.0.
You're free to use it as you wish, the full license text is attached in the LICENSE file.
The best way to ask for features / improvements is via the Issues section on github - it's better than email because I won't loose when I have a "million emails inbox" day, and maybe someone else has some idea or would like to upvote your issue.
That's all folks! Happy hacking!