技术标签: plugin maven git-commit-id插件
参考:
git-commit-id-plugin
是一个类似于 buildnumber-maven-plugin 的插件,由于buildnumber-maven-plugin
插件仅支持 CVS 和 SVN,所以作者就开发了一个支持Git版。这个插件主要有以下几个功能:
查看插件目标、绑定阶段、参数等信息
help
插件的describe
目标:http://maven.apache.org/plugins/maven-help-plugin/:
mvn help:describe -Dplugin=pl.project13.maven:git-commit-id-plugin:2.2.5 -Ddetail
这个插件一共有2个目标:
initialize
verify
将构建时的信息保存到指定文件中或maven的属性中,默认绑定生命周期的阶段(phase):initialize
相关参数如下:
参数 | 默认值 | 描述 |
---|---|---|
abbrevLength | 7 | git.commit.id.abbrev 属性的长度,取值范围在[2, 40],即打印的object id 的长度 |
commitIdGenerationMode | flat | git.commit.id 属性的生成模式,可选值:flat、full |
dateFormat | yyyy-MM-dd’T’HH:mm:ssZ | 定义这个插件的使用日期的格式 |
dateFormatTimeZone | 定义日期时区,如:America/Los_Angeles、GMT+10、PST | |
dotGitDirectory | ${project.basedir}/.git | 需要检查的仓库根目录 |
evaluateOnCommit | HEAD | 告诉插件生成属性参考哪次提交 |
failOnNoGitDirectory | true | 没有 .git 目录时则构建失败,false:继续构建 |
failOnUnableToExtractRepoInfo | true | 获取不到足够数据则构建失败,false:继续构建 |
format | properties | 保存属性的格式:properties 或 json |
generateGitPropertiesFile | false | true:生成git.properties文件,默认只是将属性添加到maven项目属性中 |
generateGitPropertiesFilename | ${project.build.outputDirectory}/git.properties) | git.properties文件的位置,在generateGitPropertiesFile=true时有效 |
gitDescribe | 配置git-describe命令,可以修改dirty标志、abbrev长度、其他可选项 | |
excludeProperties | 需要隐藏的属性列表,如:仓库地址git.remote.origin.url、用户信息git.commit.user.* | |
includeOnlyProperties | 需要保存到文件中的属性列表,该列表会被excludeProperties属性配置的值覆盖 | |
injectAllReactorProjects | false | true:将git属性注入所有项目 |
prefix | git | 属性的前缀,如生成的属性都是:git.xxx |
replacementProperties | 在生成的git属性中通过表达式替换字符或字符串 | |
runOnlyOnce | false | true:在多模块构建中只执行一次 |
skip | false | true:跳过插件执行 |
skipPoms | true | false:执行以pom方式打包的项目 |
skipViaCommandLine | false | true:通过命令行方式跳过插件执行,属性:maven.gitcommitid.skip |
useNativeGit | false | true:使用原生git去获取仓库信息 |
verbose | false | true:扫描路径时打印更多信息 |
校验属性是否符合预期值,默认绑定阶段:verify
相关参数如下:
参数 | 默认值 | 描述 |
---|---|---|
validationProperties | 需要校验的属性 | |
validationShouldFailIfNoMatch | true | true:不匹配时则构建失败 |
需求:
实现:
<generateGitPropertiesFile>
为true,生成git.properties文件,保存至编译后的classes目录下示例:
(1)插件配置
默认和生命周期的initialize
阶段绑定,所以在initialize
阶段后任一阶段如:compile、package等,都会生成git.properties文件
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
<version>2.2.5</version>
<executions>
<execution>
<id>get-the-git-infos</id>
<!-- 默认绑定阶段initialize -->
<phase>initialize</phase>
<goals>
<!-- 目标:revision -->
<goal>revision</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- 检查的仓库根目录,${project.basedir}:项目根目录,即包含pom.xml文件的目录 -->
<dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
<!-- false:扫描路径时不打印更多信息,默认值false,可以不配置 -->
<verbose>false</verbose>
<!-- 定义插件中所有时间格式,默认值:yyyy-MM-dd’T’HH:mm:ssZ -->
<dateFormat>yyyy-MM-dd HH:mm:ss</dateFormat>
<!-- git属性文件中各属性前缀,默认值git,可以不配置 -->
<prefix>git</prefix>
<!-- 生成git属性文件,默认false:不生成 -->
<generateGitPropertiesFile>true</generateGitPropertiesFile>
<!-- 生成git属性文件路径及文件名,默认${project.build.outputDirectory}/git.properties -->
<generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
<!-- 生成git属性文件格式,默认值properties -->
<format>json</format>
<!-- 配置git-describe命令 -->
<gitDescribe>
<skip>false</skip>
<always>false</always>
<dirty>-dirty</dirty>
</gitDescribe>
</configuration>
</plugin>
(2)获取git.properties文件属性
定义一个Controller,读取git.properties文件即可。
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
@RestController
@RequestMapping("/version")
public class VersionController {
@GetMapping("/info")
public Map<String, Object> getVersionInfo() {
return readGitProperties();
}
private Map<String, Object> readGitProperties() {
InputStream inputStream = null;
try {
ClassLoader classLoader = getClass().getClassLoader();
inputStream = classLoader.getResourceAsStream("git.properties");
// 读取文件内容,自定义一个方法实现即可
String versionJson = FileUtils.getStringFromStream(inputStream);
JSONObject jsonObject = JSON.parseObject(versionJson);
Set<Map.Entry<String, Object>> entrySet = jsonObject.entrySet();
if (CollectionUtils.isNotEmpty(entrySet)) {
return entrySet.stream()
.collect(Collectors.toMap(e -> e.getKey(), e -> e.getValue(), (o, n) -> n));
}
} catch (Exception e) {
log.error("get git version info fail", e);
} finally {
try {
if (inputStream != null) {
inputStream.close();
}
} catch (Exception e) {
log.error("close inputstream fail", e);
}
}
return new HashMap<>();
}
}
(3)测试
启动项目,在编译后的classes目录下可以看到git.properties文件:
{
"git.branch" : "master",
"git.build.host" : "localhost",
"git.build.time" : "2019-08-28 17:05:33",
"git.build.user.email" : "[email protected]",
"git.build.user.name" : "xxx",
"git.build.version" : "1.0-SNAPSHOT",
"git.closest.tag.commit.count" : "",
"git.closest.tag.name" : "",
"git.commit.id" : "437e26172c51cab8fc88ea585145797df222fbb2",
"git.commit.id.abbrev" : "437e261",
"git.commit.id.describe" : "437e261-dirty",
"git.commit.id.describe-short" : "437e261-dirty",
"git.commit.message.full" : "获取版本信息",
"git.commit.message.short" : "获取版本信息",
"git.commit.time" : "2019-08-27 19:07:03",
"git.commit.user.email" : "[email protected]",
"git.commit.user.name" : "xxx",
"git.dirty" : "true",
"git.remote.origin.url" : "http://git.xxx.cn/gitlab/git/xxx.git",
"git.tags" : "",
"git.total.commit.count" : "3324"
}
访问步骤2中定义的接口,即可获取到git.properties文件中属性。
需求:
<artifactId>-<version>.jar
(没有通过<finalName>
标签指定),由于version不是都需要改动,所以需要额外参数来控制版本实现:
git.commit.id.abbrev
(由插件将该属性注入到maven项目中,可以在pom文件中引用)示例:
(1)pom.xml配置如下:
<groupId>com.momo</groupId>
<artifactId>myproject</artifactId>
<!-- 拼接最后一次git提交的版本号,默认7位 -->
<version>1.0.0-${git.commit.id.abbrev}</version>
<build>
<plugins>
<!-- git-commit-id插件,配置同示例2.1 -->
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
<version>2.2.5</version>
<executions>
<execution>
<id>get-the-git-infos</id>
<phase>initialize</phase>
<goals>
<goal>revision</goal>
</goals>
</execution>
</executions>
<configuration>
<dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
<prefix>git</prefix>
<verbose>false</verbose>
<dateFormat>yyyy-MM-dd HH:mm:ss</dateFormat>
<generateGitPropertiesFile>true</generateGitPropertiesFile>
<generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
<format>json</format>
<!-- git.commit.id.abbrev属性值的长度,取值范围在[2, 40],默认值7 -->
<abbrevLength>7</abbrevLength>
<gitDescribe>
<skip>false</skip>
<always>false</always>
<dirty>-dirty</dirty>
</gitDescribe>
</configuration>
</plugin>
</plugins>
</build>
(2)执行package命令
可以看到打包的文件名为:myproject-1.0.0-a30b2ff.jar
myproject-1.0.0-a30b2ffd11.jar
需求:
git.dirty
属性,期望值:false(true:仓库脏,如修改后的文件没有commit,false:表示仓库干净)示例:
(1)pom中插件配置如下:
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
<version>2.2.5</version>
<executions>
<execution>
<id>get-the-git-infos</id>
<phase>initialize</phase>
<goals>
<goal>revision</goal>
</goals>
</execution>
<!-- 绑定validateRevision目标到package阶段 -->
<execution>
<id>validate-the-git-infos</id>
<phase>package</phase>
<goals>
<goal>validateRevision</goal>
</goals>
</execution>
</executions>
<configuration>
<dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
<verbose>false</verbose>
<dateFormat>yyyy-MM-dd HH:mm:ss</dateFormat>
<prefix>git</prefix>
<generateGitPropertiesFile>true</generateGitPropertiesFile>
<generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
<format>json</format>
<gitDescribe>
<skip>false</skip>
<always>false</always>
<dirty>-dirty</dirty>
</gitDescribe>
<!-- 定义需要校验的属性 -->
<validationProperties>
<validationProperty>
<!-- 校验失败时提示使用 -->
<name>validating git dirty</name>
<!-- 需要校验的属性 -->
<value>${git.dirty}</value>
<!-- 期望的属性值:false -->
<shouldMatchTo>false</shouldMatchTo>
</validationProperty>
</validationProperties>
<!-- 配置校验的属性值与期望值不一致是否构建失败,默认值true:失败,false:继续构建 -->
<validationShouldFailIfNoMatch>true</validationShouldFailIfNoMatch>
</configuration>
</plugin>
(2)测试
package
命令,此时会构建失败:<shouldMatchTo>
属性值改为true,此时构建成功<validationShouldFailIfNoMatch>
属性值修改为false,此时构建也可以成功注:
校验项目名称、提交是否有tag示例(都是来自于官方文档):
<validationProperties>
<!-- 校验项目版本是否以`-SNAPSHOT`结尾 -->
<validationProperty>
<name>validating project version</name>
<value>${project.version}</value>
<shouldMatchTo><![CDATA[^.*(?<!-SNAPSHOT)$]]></shouldMatchTo>
</validationProperty>
<!-- 校验当前提交是否有tag -->
<validationProperty>
<name>validating current commit has a tag</name>
<value>${git.closest.tag.commit.count}</value>
<shouldMatchTo>0</shouldMatchTo>
</validationProperty>
</validationProperties>
注:详细参数说明参考官方文档,以上翻译仅供参考。
文章浏览阅读2.5w次,点赞6次,收藏50次。官方解释是,docker 容器是机器上的沙盒进程,它与主机上的所有其他进程隔离。所以容器只是操作系统中被隔离开来的一个进程,所谓的容器化,其实也只是对操作系统进行欺骗的一种语法糖。_docker菜鸟教程
文章浏览阅读5.7k次,点赞3次,收藏14次。该如何避免的,今天小编给大家推荐两个下载Windows系统官方软件的资源网站,可以杜绝软件捆绑等行为。该站提供了丰富的Windows官方技术资源,比较重要的有MSDN技术资源文档库、官方工具和资源、应用程序、开发人员工具(Visual Studio 、SQLServer等等)、系统镜像、设计人员工具等。总的来说,这两个都是非常优秀的Windows系统镜像资源站,提供了丰富的Windows系统镜像资源,并且保证了资源的纯净和安全性,有需要的朋友可以去了解一下。这个非常实用的资源网站的创建者是国内的一个网友。_msdn我告诉你
文章浏览阅读1.2k次。vue2封装对话框el-dialog组件_
文章浏览阅读4.7k次,点赞5次,收藏6次。MFC 文本框换行 标签: it mfc 文本框1.将Multiline属性设置为True2.换行是使用"\r\n" (宽字符串为L"\r\n")3.如果需要编辑并且按Enter键换行,还要将 Want Return 设置为 True4.如果需要垂直滚动条的话将Vertical Scroll属性设置为True,需要水平滚动条的话将Horizontal Scroll属性设_c++ mfc同一框内输入二行怎么换行
文章浏览阅读832次。检查Linux是否是否开启所需端口,默认为6379,若未打开,将其开启:以root用户执行iptables -I INPUT -p tcp --dport 6379 -j ACCEPT如果还是未能解决,修改redis.conf,修改主机地址:bind 192.168.85.**;然后使用该配置文件,重新启动Redis服务./redis-server redis.conf..._redis-server doesn't support auth command or ismisconfigured. try
文章浏览阅读4.9k次。济大数电实验报告_数据选择器及其应用
文章浏览阅读236次。1研究内容消费在生产中占据十分重要的地位,是生产的最终目的和动力,是保持省内经济稳定快速发展的核心要素。预测河南省社会消费品零售总额,是进行宏观经济调控和消费体制改变创新的基础,是河南省内人民对美好的全面和谐社会的追求的要求,保持河南省经济稳定和可持续发展具有重要意义。本文建立灰色预测模型,利用MATLAB软件,预测出2019年~2023年河南省社会消费品零售总额预测值分别为21881...._灰色预测模型用什么软件
文章浏览阅读1.2k次。12.4-在Qt中使用Log4Qt输出Log文件,看这一篇就足够了一、为啥要使用第三方Log库,而不用平台自带的Log库二、Log4j系列库的功能介绍与基本概念三、Log4Qt库的基本介绍四、将Log4qt组装成为一个单独模块五、使用配置文件的方式配置Log4Qt六、使用代码的方式配置Log4Qt七、在Qt工程中引入Log4Qt库模块的方法八、获取示例中的源代码一、为啥要使用第三方Log库,而不用平台自带的Log库首先要说明的是,在平时开发和调试中开发平台自带的“打印输出”已经足够了。但_log4qt
文章浏览阅读786次。全局观思维模型,一个教我们由点到线,由线到面,再由面到体,不断的放大格局去思考问题的思维模型。_计算机中对于全局观的
文章浏览阅读330次。一、CountDownLatch介绍CountDownLatch采用减法计算;是一个同步辅助工具类和CyclicBarrier类功能类似,允许一个或多个线程等待,直到在其他线程中执行的一组操作完成。二、CountDownLatch俩种应用场景: 场景一:所有线程在等待开始信号(startSignal.await()),主流程发出开始信号通知,既执行startSignal.countDown()方法后;所有线程才开始执行;每个线程执行完发出做完信号,既执行do..._countdownluach于cyclicbarrier的用法
文章浏览阅读508次。Prometheus 算是一个全能型选手,原生支持容器监控,当然监控传统应用也不是吃干饭的,所以就是容器和非容器他都支持,所有的监控系统都具备这个流程,_-自动化监控系统prometheus&grafana实战
文章浏览阅读4.7k次。输入关键字,可以通过键盘的搜索按钮完成搜索功能。_react search