发布项目到Maven中央仓库的最佳实践
最近尝试发布自己的项目到Maven中央仓库,发现网上的教程虽然不少,但多多少少都有一些问题,其中最主要的问题是几乎所有的教程都指定Maven项目的parent为oss-parent,然而Maven不支持多parent的情况,因此这样操作必须要求原有的Maven项目无parent项目。下面言归正传,介绍一下我认为的发布项目到Maven中央仓库的最佳实践。
首先发布项目到Maven中央仓库主要有以下步骤:
1. 在sonatype中创建issue
2. 使用gpg生成秘钥
3. 配置Maven进行deploy和release
1. Sonatype
Sonatype是一个通过Nexus对开源项目提供托管服务的网站。你可以通过它发布项目的快照(snapshot)或者稳定版本(release)到Maven中央仓库。我们只需要注册一个Sonatype的账号,新建一个issue,然后在项目的pom文件中进行配置即可。
1.1 新建issue
首先我们在 https://issues.sonatype.org/secure/Dashboard.jspa 新建一个issue。新建issue前需要登录,如果还没有账号的话请先进行注册。登录后界面如下:
Sonatype点击导航栏上的Create按钮,开始新建一个issue:
Create issue依次填写Summary, Group Id, Project URL, SCM URL。填写完成后点击Create按钮,一个issue就新建成功了。
issue新建成功issue后需要等待Sonatype的工作人员进行审核,审核时间大约两小时左右,审核通过后issue的Status会转变为Resolved,此时你就可以进行下一步操作了。
2. 使用gpg生成秘钥
2.1 安装
gpg(GunPG)是一款用于生成秘钥的加密软件。Windows下载地址:https://www.gpg4win.org/download.html
Ubuntu可以使用如下命令进行安装:
sudo apt-get install gnupg
安装后可以通过 gpg --version 命令查看是否安装成功。
2.2 生成秘钥
运行以下命令生成秘钥,当前gpg版本为1.4.20:
gpg --gen-keygpg --gen-key
运行后gpg要求你选择加密算法,过期时间等等,这些直接选择默认值即可。通过对比发现,gpg 2.0以上的版本运行gpg --gen-key命令 会跳过这些步骤。
之后gpg要求你输入姓名,邮箱以及关键的Passphrase,依次输入即可。然后gpg为你生成了一对秘钥。
gpg注意此截图中从倒数第四行开始就是gpg生成的秘钥。pub代表公钥,截图中的AA96D540是此公钥的摘要信息,后续步骤中会使用到。
通过 gpg --list-keys 命令可以查看秘钥:
gpg值得注意是,Windows下安装了gpg 2.2.3,运行 gpg --gen-key 除了生成步骤更加简单之外,显示的结果也产生了一定的变化,gpg 2.2.3下生成的秘钥如下:
gpg 2.2.32.3 上传公钥
生成秘钥后,我们需要把公钥上传到服务器上。运行以下命令:
gpg2 --keyserver hkp://pool.sks-keyservers.net --send-keys AA96D54D
其中AA96D540是gpg生成的公钥。此处替换为你本地gpg生成的公钥即可。
3. 配置Maven
配置Maven主要有两种方式,方式一:依赖oss-parent。方式二:手动添加各种依赖。
方式一请参考这篇文章:https://www.iteblog.com/archives/1807.html
下面主要介绍以下如何在不设置parent的情况下配置Maven。
3.1 配置pom
完整的pom参见:https://github.com/cheergoivan/totp-authenticator-spring-boot-starter/blob/master/pom.xml
首先在项目的pom文件中添加指向sonatype仓库的<distributionManagement>
distributionManagement上述的配置是将本项目的deploy仓库设置为sonatype的仓库。
继续编辑pom,如果pom中不存在profile则添加一个<profiles>标签,再在<profiles>下添加一个用于release的profile,主要使用了javadoc, source 和 gpg的build插件:
profile profile继续编辑pom,添加license,仓库,开发者等信息:
license3.2 配置Maven
由于sonatype需要身份认证,因此还需要在Maven的settins.xml文件中配置server ossrh。步骤:打开 MAVEN_HOME/conf/settings.xml,在标签下添加一个server如下:
server其中用户名密码为 ttps://issues.sonatype.org/secure/Dashboard.jspa 的用户名和密码。
继续编辑 MAVEN_HOME/conf/settings.xml, 在<profiles>标签下添加一个对gpg支持的profile:
profilethe_pass_phrase 是使用gpg生成秘钥时要求你输入的密码。
3.3 运行mvn deploy
运行以下命令进行deploy:
deploymvn clean deploy -P release
如图所示,项目成功上传之ossrh服务器上。
3.4 close and release
项目上传到sonatype仓库后,访问 https://oss.sonatype.org/#stagingRepositories 进行查看。进入此网站后,可以看到正中间的Staging Repositories,直接下拉到最后一个,如图:
stage最后一个即为你发布到sonatype仓库的项目,点击左上角的close按钮。当项目状态变为closed之后,点击release按钮,输入必要的description信息后,就发布成功了。大约几小时后你就可以在中央仓库上搜索到你的项目了!
3.5 自动release插件
最后提一下sonatype提供了自动release的插件,这意味着运行mvn clean deploy后不用手动去close-> release了,此插件会自动release我们的项目到Maven中央仓库。引入方法:
auto-release总结: 由于简书富文本编辑器的bug,导致我无法复制xml文本,因此本文中的xml文本均为图片,本文主要参考自sonatype官方文档,大家可以去自行复制xml:http://central.sonatype.org/pages/apache-maven.html