git-commit-id-maven-plugin

maven git commit id plugin

Exports git version info to maven as properties in the pom.xml and as a file in the build output. Code generation and resource loading enable access to the build’s version info at runtime.
Unsure if this addresses your problem? Read about common use cases.

Quick Start

The plugin is available from Maven Central. Simply add the following to your pom.xml:

<plugin>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-maven-plugin</artifactId>
    <version>9.2.0</version>
    <executions>
        <execution>
            <id>get-the-git-infos</id>
            <goals>
                <goal>revision</goal>
            </goals>
            <phase>initialize</phase>
        </execution>
    </executions>
    <configuration>
        <generateGitPropertiesFile>true</generateGitPropertiesFile>
        <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
        <commitIdGenerationMode>full</commitIdGenerationMode>
    </configuration>
</plugin>

Minimum Requirements

• Java 11
• Maven 3.9.0

Documentation

• Use Cases
• Configuration & Properties
• Access Version Info At Runtime
• git describe
• All Configuration Options as Javadoc
• Frequently Asked Questions
• Contributing
• Releases
• Old Versions
• Snapshots

Maintainers

This project is currently maintained thanks to: @ktoso (founder), @TheSnoozer

Notable contributions

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 :-)

Notable happy users

• neo4j – graph database
• FoundationdDB – 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.

License

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.

Feature requests

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!