maven-release-plugin主要有三个目标,他们分别为:
release:prepare准备版本发布,依次执行下列操作:
- 检查项目是否有未提交的代码。
- 检查项目是否有快照版本依赖。
- 根据用户的输入将快照版本升级为发布版。
- 将POM中的SCM信息更新为标签地址。
- 基于修改后的POM执行Maven构建。
- 提交POM变更。
- 基于用户输入为代码打标签。
- 将代码从发布版升级为新的快照版。
- 提交POM变更。
release:rollback回退release:prepare所执行的操作。将POM回退至release:prepare之前的状态,并提交。需要注意的是,该步骤不会删除release:prepare生成的标签,因此用户需要手动删除。
release:perform执行版本发布。签出release:prepare生成的标签中的源代码,并在此基础上执行mvn deploy命令打包并部署构件至仓库。
要为项目发布版本,首先需要为其添加正确的版本控制系统信息,这是因为Maven Release Plugin需要知道版本控制系统的主干,标签等地址信息后才能执行相关的操作。一般配置项目的SCM信息如下:
<project>
<scm>
<connection>scm:git:http://项目git地址</connection>
<url>项目git地址(不加'.git后缀')</url>
<developerConnection>scm:项目git地址</developerConnection>
</scm>
</project>
该配置只告诉Maven当前代码的位置(主干),而版本发布还要涉及标签操作。因此还需要配置maven-release-plugin告诉其标签的基础目录,如下:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.3</version>
<configuration>
<tagNameFormat>v@{project.version}</tagNameFormat>
<autoVersionSubmodules>true</autoVersionSubmodules>
</configuration>
</plugin>
在执行release:prepare之前还有两个注意点:第一系统必须提供svn命令行工具,Maven需要svn命令行工具执行相关操作,而无法使用图形化的工具;第二,POM必须配置了可用的部署仓库,因为release:perform会执行deploy操作将构件发布到仓库中。一切就绪之后,在项目跟目录下运行如下命令:
mvn release:prepare
如果需要跳过单元测试,可以加入参数 -Darguments="-DskipTests",直接使用-Dmaven.test.skip=true是无效的。
maven-release-plugin开始准备发布版本,如果它检测到项目有为提交的代码或者项目有快照的依赖,则会提示出错。如果一切都没有问题,则会提示用户输入想要发布的版本号,标签的名称以及新的快照版本号。
至此release:prepare的工作完成。如果这时你发现了一些问题,例如将标签名称配置错了,则可以使用release:rollback命令回退发布,maven-release-plugin会将POM的配置回到release:prepare之前的状态。但需要注意的是,版本控制系统中的标签并不会被删除,也就是说用户需要手动执行版本控制系统命令删除该标签。
在多模块项目中执行release:prepare的时候,默认maven-release-plugin会提示用户设定每个模块发布版本号及新的开发版本号(如在xxx-parent模块中配置)。但是很多情况下我们希望所有模块的发布版本以及新的SNAPSHOT开发版本都保持一致。为了避免重复确认,maven-release-plugin提供了autoVersionSubmodules参数,运行下面命令后,maven-release-plugin就会自动为所有子模块使用与父模块一致的发布版本和新的SNAPSHOT版本:
mvn release:prepare -DautoVersionSubmodules=true
如果检查下来release:prepare的结果没有问题,标签和新的开发版本都是正确的,可以执行如下发布执命令:
mvn release:perform
如果你所发布项目的打包类型为jar,在执行release:perform之后,不仅项目的主构件会被生成并发布到仓库中,基于该主构件的-sources.jar和-javadoc.jar也会生成并发布。在执行mvn release:perform时默认会生成api文档,如果默写注释不符合规范的话会造成构建失败,可以加参数-DuseReleaseProfile=false取消构建api文档,或则需要根据规范书写注释。
自动化创建分支:用的不多以后再补。