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

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

第一步 注册Sonatype的账户

地址:https://issues.sonatype.org/secure/Signup!default.jspa
【踩坑提示】 这里的密码要求极其之高,比之前见过的其他网站或公司要求还要变态。注册的同时,一定要拿小本本把密码记好,不然后面会哭

第二步 提交发布申请

点击界面上方 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中央仓库_第1张图片

第三步 配置Maven

3.1. 配置settings.xml文件

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


  sonatype-nexus-snapshots
  Sonatype账号
  Sonatype密码


  sonatype-nexus-staging
  Sonatype账号
  Sonatype密码

3.2. 修改项目pom.xml文件

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


  
    The Apache Software License, Version 2.0
    http://www.apache.org/licenses/LICENSE-2.0.txt
    repo
  


  master
  [email protected]:snowheart/dingtalk-robot.git
  scm:git:[email protected]:snowheart/dingtalk-robot.git
  scm:git:[email protected]:snowheart/dingtalk-robot.git


  
    Wanxiang Liu
    [email protected]
    snowheart
  

增加发布Release的相关profile配置,distributionManagement节和maven-compiler-plugin节的配置信息根据自己的实际情况做修改。
【踩坑提示】 记住这里profile的id值。后续打包的时候会用到。


  release
  
    
      
      
        org.apache.maven.plugins
        maven-source-plugin
        2.2.1
        
          
            package
            
              jar-no-fork
            
          
        
      
      
      
        org.apache.maven.plugins
        maven-javadoc-plugin
        2.9.1
        
          
            package
            
              jar
            
          
        
      
      
      
        org.apache.maven.plugins
        maven-gpg-plugin
        1.5
        
          
            verify
            
              sign
            
          
        
      
      
      
        org.apache.maven.plugins
        maven-compiler-plugin
        3.0
        
          1.7
          1.7
          true
          true
          UTF-8
          false
        
      
      
      
        org.apache.maven.plugins
        maven-release-plugin
        2.5.1
      
    
  
  
    
      sonatype-nexus-snapshots
      Sonatype Nexus Snapshots
      https://oss.sonatype.org/content/repositories/snapshots/
    
    
      sonatype-nexus-staging
      Nexus Release Repository
      https://oss.sonatype.org/service/local/staging/deploy/maven2/
    
  

第四步 配置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 
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 命令,一键打包。
打包过程中会要求输入gpg密钥的Passphase信息,输入即可

第六步 发布Release

进入https://oss.sonatype.org/#stagingRepositories查看发布好的构件,点击左侧的Staging Repositories,一般最后一个就是刚刚发布的jar了,此时的构件状态为 Open
选中构件,并点击上方的 Close–>Confirm 在下边的Activity选项卡中查看状态。
当状态变成closed后,执行 Release–>Confirm 并在下边的Activity选项卡中查看状态。
成功后构件自动删除,一小段时间(约1-2个小时)后即可同步到maven的中央仓库。届时会有邮件通知。

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

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

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

https://search.maven.org/
https://mvnrepository.com/

##参考资料
VF的博客 https://blog.csdn.net/tiger435/article/details/50470316
GPG入门教程 http://www.ruanyifeng.com/blog/2013/07/gpg.html
十分钟年华老去的博客 https://blog.csdn.net/zdsdiablo/article/details/53536788
brianway的博客 https://segmentfault.com/a/1190000009450347

你可能感兴趣的:(Maven)