如何将自己的开源项目发布到Maven中央仓库

1,045 阅读4分钟

今年清明节写好dingtalk-robot的轮子的时候,当时就想着把jar包上传至Maven的中央仓库,跟着各路大神的教程试了许久,折腾了一天之后,还是卡在401权限报错上面,始终无法deploy。今天心血来潮,对原有的代码做了一点点小的改动,立下了今天一定要把包上传上去的flag。踩过无数坑之后,终于上传成功。才发现自己8个月以前,竟然是被密码这一关给难住了,真是灯下黑。

第一步 注册Sonatype的账户

地址:issues.sonatype.org/secure/Sign…

【踩坑提示】 这里的密码要求极其之高,比之前见过的其他网站或公司要求还要变态。注册的同时,一定要拿小本本把密码记好,不然后面会哭

第二步 提交发布申请

点击界面上方 Create 按钮即可创建Issue。

Project: Community Support - Open Source Project Repository Hosting (OSSRH)
Issue TypeRequired: New Project

Summary: Jar包的名称
Group Id:cn.snowheart
Project URL:项目站点,如:https://gitee.com/snowheart/dingtalk-robot
SCM url:项目源码仓库,如:https://gitee.com/snowheart/dingtalk-robot.git

其余内容按照个人情况填写,可以不用填写,使用默认值。

提交后等待工作人员审核,待状态为 RESOLVED 时即可进行后续操作。这一步不会等太久,有结果后同样会受到相应的邮件通知。此时Issue下会有类似于这样的评论。 评论截图

第三步 配置Maven

3.1. 配置settings.xml文件

servers节点内部增加如下server配置

<server>
  <id>sonatype-nexus-snapshots</id>
  <username>Sonatype账号</username>
  <password>Sonatype密码</password>
</server>
<server>
  <id>sonatype-nexus-staging</id>
  <username>Sonatype账号</username>
  <password>Sonatype密码</password>
</server>

3.2. 修改项目pom.xml文件

增加许可协议、SCM信息、开发者信息

<licenses>
  <license>
    <name>The Apache Software License, Version 2.0</name>
    <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
    <distribution>repo</distribution>
  </license>
</licenses>
<scm>
  <tag>master</tag>
  <url>git@gitee.com:snowheart/dingtalk-robot.git</url>
  <connection>scm:git:git@gitee.com:snowheart/dingtalk-robot.git</connection>
  <developerConnection>scm:git:git@gitee.com:snowheart/dingtalk-robot.git</developerConnection>
</scm>
<developers>
  <developer>
    <name>Wanxiang Liu</name>
    <email>sxjwzxlwx@yeah.net</email>
    <organization>snowheart</organization>
  </developer>
</developers>

增加发布Release的相关profile配置,distributionManagement节和maven-compiler-plugin节的配置信息根据自己的实际情况做修改。

【踩坑提示】 记住这里profile的id值。后续打包的时候会用到。

<profile>
  <id>release</id>
  <build>
    <plugins>
      <!-- Source -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-source-plugin</artifactId>
        <version>2.2.1</version>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>jar-no-fork</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <!-- Javadoc -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9.1</version>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>jar</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <!-- GPG -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-gpg-plugin</artifactId>
        <version>1.5</version>
        <executions>
          <execution>
            <phase>verify</phase>
            <goals>
              <goal>sign</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <!--Compiler-->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.0</version>
        <configuration>
          <source>1.7</source>
          <target>1.7</target>
          <fork>true</fork>
          <verbose>true</verbose>
          <encoding>UTF-8</encoding>
          <showWarnings>false</showWarnings>
        </configuration>
      </plugin>
      <!--Release-->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-release-plugin</artifactId>
        <version>2.5.1</version>
      </plugin>
    </plugins>
  </build>
  <distributionManagement>
    <snapshotRepository>
      <id>sonatype-nexus-snapshots</id>
      <name>Sonatype Nexus Snapshots</name>
      <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    </snapshotRepository>
    <repository>
      <id>sonatype-nexus-staging</id>
      <name>Nexus Release Repository</name>
      <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
    </repository>
  </distributionManagement>
</profile>

第四步 配置pgp的公私钥信息

Windows下使用gpg4win来进行配置。下载地址 https://www.gpg4win.org/get-gpg4win.html

安装好之后,打开cmd控制台,使用gpg --list-keys命令来查询自己配置的key

如果提示gpg不是可执行程序或命令,请配置Path路径到 GnuPG 的bin目录

生成密钥的命令 gpg --gen-key,过程中需要使用到姓名、邮箱等信息,这里的配置最好和Sonatype注册信息、pom文件配置信息保持一致,以免不必要的麻烦。

生成的过程中,会有个弹框要求输入Passphase信息,这个是密钥的密码,同样需要记牢。发布签名的过程中会用得到。

使用 gpg --list-keys 命令查询配置好的公私钥信息,使用 gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys <公钥key> 将公钥信息发送到ubuntu.com服务器,后续推送maven仓库会做校验。

C:\Users\Lwx> gpg --list-keys
C:/Users/Lwx/AppData/Roaming/gnupg/pubring.kbx
----------------------------------------------
pub   rsa2048 2018-12-15 [SC] [expires: 2020-12-14]
      01C6D8A0B3C1DFD78CEE66E73B4D46C0075BD34C
uid           [ultimate] Wanxiang Liu <sxjwzxlwx@yeah.net>
sub   rsa2048 2018-12-15 [E] [expires: 2020-12-14]


C:\Users\Lwx> gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys 01C6D8A0B3C1DFD78CEE66E73B4D46C0075BD34C
gpg: sending key 01C6D8A0B to hkp server keyserver.ubuntu.com

第五步 打包Deploy

使用 mvn clean deploy -P <profile-id> 命令,一键打包。

打包过程中会要求输入gpg密钥的Passphase信息,输入即可

第六步 发布Release

进入 oss.sonatype.org/#stagingRep… 查看发布好的构件,点击左侧的Staging Repositories,一般最后一个就是刚刚发布的jar了,此时的构件状态为 Open

选中构件,并点击上方的 Close–>Confirm 在下边的Activity选项卡中查看状态。

当状态变成closed后,执行 Release–>Confirm 并在下边的Activity选项卡中查看状态。

成功后构件自动删除,一小段时间(约1-2个小时)后即可同步到maven的中央仓库。届时会有邮件通知。

至此,发布到Maven中央仓库完成。

第七步 扫尾工作

对第二步提交的Issue增加Comment,留言致谢并表示发布已经完成,请工作人员关闭Issue。

在以下两个网站可以对自己上传的包进行搜索。

search.maven.org/ mvnrepository.com/

##参考资料 VF的博客 blog.csdn.net/tiger435/ar… GPG入门教程 www.ruanyifeng.com/blog/2013/0… 十分钟年华老去的博客 blog.csdn.net/zdsdiablo/a… brianway的博客 segmentfault.com/a/119000000…