Maven 项目获取 git 分支、提交等信息

2024-11-02 来源：个人技术集锦

git-commit-id-plugin 是一个 Maven 插件，用于在 Maven 项目的构建过程中自动获取 git 仓库的信息，如最后一次提交的 ID、分支名称、构建时间等，并将这些信息注入到项目的属性文件中。这对于跟踪项目版本和构建状态非常有用。

以下是如何在 Maven 项目中使用 git-commit-id-plugin 的基本步骤：

添加插件到 pom.xml 文件中：
在你的 Maven 项目的 pom.xml 文件中，添加 git-commit-id-plugin 到 <plugins> 部分。

<build>
    <plugins>
        <plugin>
            <groupId>pl.project13.maven</groupId>
            <artifactId>git-commit-id-plugin</artifactId>
            <version>4.0.5</version>
            <executions>
                <execution>
                    <goals>
                        <goal>revision</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <!-- 配置选项 -->
            </configuration>
        </plugin>
    </plugins>
</build>

配置插件：
在 <configuration> 标签中，你可以配置多种选项，例如生成的属性文件的位置、包含哪些 git 属性等。默认情况下，插件会生成一个 git.properties 文件在 target/classes 目录下。

<configuration>
    <dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
    <generateGitPropertiesFile>true</generateGitPropertiesFile>
    <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
    <format>properties</format>
</configuration>

构建项目：
使用 Maven 命令构建你的项目，例如 mvn clean install。构建过程中，git-commit-id-plugin 会自动运行，并生成包含 git 信息的 git.properties 文件。
使用 git 信息：
在你的应用程序中，你可以加载 git.properties 文件来获取 git 信息，并用于显示版本信息、日志记录等。

这样，你就可以在 Maven 项目中利用 git-commit-id-plugin 来自动获取和使用 git 版本信息了。

显示全文

全部栏目

Maven 项目获取 git 分支、提交等信息