Git-Commit-Id-Plugin 插件

一、概述

你是否还在为了控制多个项目的软件版本，在努力的 打分支、打tag？ 是否还在苦恼自己忘了某个项目的发布版本找不到了？没法进行 hotfix 、没法修复重大漏洞。只能硬着头皮升级最新版本？

那么我们是否可以通过某种机制，在项目打包的时候把当前的git版本信息记录下来那 ？ 这样一旦需要的时候，就可以很容易的定位项目现场部署的版本了。解决各种问题也就更容易下手了。

Git-Commit-Id-Plugin 插件就为此而生，它可以自动的将git版本信息生成到 classes 目录下的 git.properties 文件中。

二、使用方法

直接在项目主pom的build 节点下，引入如下插件：

<build>
        <plugins>
            <!--打包jar 与git commit 关联插件-->
            <plugin>
                <groupId>io.github.git-commit-id</groupId>
                <artifactId>git-commit-id-maven-plugin</artifactId>
                <version>${git.commit.plugin}</version>
                <executions>
                    <execution>
                        <id>get-the-git-infos</id>
                        <goals>
                            <goal>revision</goal>
                        </goals>
                        <phase>initialize</phase>
                    </execution>
                </executions>
                <configuration>
                    <failOnNoGitDirectory>false</failOnNoGitDirectory>
                    <generateGitPropertiesFile>true</generateGitPropertiesFile>
                    <dateFormat>yyyy-MM-dd HH:mm:ss</dateFormat>
                    <includeOnlyProperties>
                        <includeOnlyProperty>^git.branch$</includeOnlyProperty>
                        <includeOnlyProperty>^git.build.(time|version)$</includeOnlyProperty>
                        <includeOnlyProperty>^git.commit.(id|message|time).*$</includeOnlyProperty>
                    </includeOnlyProperties>
                </configuration>
            </plugin>
        </plugins>
    </build>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

即可，完成 Git-Commit-Id-Plugin 插件的引入。

三、使用效果

1.生成文件

2.文件内容示例：

#Generated by Git-Commit-Id-Plugin
git.branch=develop #打包代码所在分支
git.build.time=2021-12-28 17\:00\:42 #构建打包时间
git.build.version=1.4.5-SNAPSHOT #项目版本号
git.commit.id=3fc0bca628825079e0b435e18a0f3917c7baca11 #全git版本号
git.commit.id.abbrev=3fc0bca #简化git版本号
git.commit.id.describe=3fc0bca
git.commit.id.describe-short=3fc0bca
git.commit.message.full=update parent to version 1.0.19-SNAPSHOT # git  commit描述
git.commit.message.short=update parent to version 1.0.19-SNAPSHOT
git.commit.time=2021-12-28 16\:40\:48 # git commit 时间
1
2
3
4
5
6
7
8
9
10
11