Maven中央仓库发布的实现方法

目录
  • 一、前言
  • 二、环境准备
  • 三、步骤说明
    • 1、工单创建
    • 2、gpg 环境安装
    • 3、Maven全局配置
    • 4、项目maven配置
    • 5、发布操作
  • 四、参考文档

一、前言

最近自己在学习Spring boot的过程中开发了一个组件 multithreadpool-spring-boot-starter,通过这个组件,我们可以动态根据配置文件进行多个线程池的初始化。既然有这个产出后,肯定是希望能够上传到maven中央仓库,给更多的人使用,于是就产生了这次项目发布经历。

整个过程可谓是一波三折,由于平时工作比较忙只能晚上花一个小时搞,所以在经历了近一周的时间后,终于成功发布上去了。

下面把我当时的上传过程记录下来,希望帮助更多的朋友。

二、环境准备

1> mac osx 10.14.6 : 本文主要以mac环境为准

2>Apache Maven 3.2.3 : 本文主要使用maven进行构建和发布例子的说明

三、步骤说明

1、工单创建

1> 访问sonatype并注册账号https://issues.sonatype.org,注意要记住账号密码,会用于我们后续的发布及相关操作

2> 如图新建一个issue,项目需要选择Community Support - Open Source Project Repository Hosting

3> 参考下图填写概要、Group Id、项目地址、代码管理地址,填写后点击确认提交。网上很多都说需要几个小时或者隔天才有回复,我当时等了10分钟就收到回复了。此时,对方跟你说两件事情:

  • 【提醒】确保 group id对应的域名是你的
  • 【校验】比如我是的项目地址是github上的,他会要求我在github上创建一个和issue同名的项目确保我拥有该项目的管理权限,

完成确认并创建和issue同名的项目后,记得要在issue进行回复,具体参考: sonatype-issueGithub仓库

4> 在通过上述的确认和校验后,sonatype会回复你到时候maven发布会用到的snapshot地址和release地址,并提醒你首次发布后需要回复该issue,详情参考issue

2、gpg 环境安装

gpg的主要作用是生成密钥对,会用于后续我们组件发布的校验。

1> 下载地址:https://www.gnupg.org/download/

2> 如图红色框所示下载并安装

3> 在安装完成后,执行以下命令生成密钥对,按照提示输入账号、邮箱、密码 (PS: 此处的密码在后面发布会用到,请务必记住)

gpg2 --gen-key 

4> 执行命令查看密钥, 此时控制台会输出类似下面的内容

$ gpg2 --list-keys
...
  pub rsa2048 2019-04-12 [SC] [有效至:2021-04-11]  9A1640F7A2551131612D51B12D83594B7B29D86A  uid           [ 绝对 ] xiaoxuetu <xiaoxuetu@163.com>  sub   rsa2048 2019-04-12 [E] [有效至:2021-04-11]

5> 执行以下命令将公钥发布到服务器中

$ gpg --keyserver hkp://subkeys.pgp.net --send-keys 9A1640F7A2551131612D51B12D83594B7B29D86A
...
gpg: 正在发送密钥 2D83594B7B29D86A 到 hkp://subkeys.pgp.net
gpg: 发送至公钥服务器失败:Server indicated a failure
gpg: 发送至公钥服务器失败:Server indicated a failure

6> 如果控制台输出如上面类似的错误内容,则将命令中的密钥调整为2D83594B7B29D86A

$ gpg --keyserver hkp://subkeys.pgp.net --send-keys 2D83594B7B29D86A
  gpg: sending key 2D83594B7B29D86A to hkp://pool.sks-keyservers.net

3、Maven全局配置

一般情况下,maven全局配置存在于 ${HOME}/.m2/setting.xml ,如果这个目录下没有,则可以从 ${MAVEN_HOME}/conf/setting.xml 拷贝一份到${HOME}/.m2 目录下并进行以下修改

1> 添加服务器验证信息

<server>
      <id>sonatype_releases</id>
      <username>your user name</username>
      <password>your password</password>
    </server>
    <server>
      <id>sonatype_snapshots</id>
      <username>your user name</username>
      <password>your password</password>
    </server>

2> 配置gpg验证命令

<settings>
  <profiles>
    <profile>
      <id>gpg</id>
      <properties>
        <!-- 由于我电脑安装的是gpg2,不存在gpg命令,所以需要指定执行gpg2,否则会报错 -->
        <gpg.executable>gpg2</gpg.executable>
        <gpg.passphrase>your password</gpg.passphrase>
      </properties>
    </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>gpg</activeProfile>
  </activeProfiles>
</settings>

4、项目maven配置

1> 在项目的pom.xml中,配置相应的开源协议、仓库信息、开发人员信息和发布配置

<!-- 开源签名证书 -->
    <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>
        <connection>scm:git:git@github.com:xiaoxuetu/multithreadpool-spring-boot-starter.git</connection>
        <developerConnection>scm:git:git@github.com:xiaoxuetu/multithreadpool-spring-boot-starter.git
        </developerConnection>
        <url>http://github.com/xiaoxuetu/multithreadpool-spring-boot-starter/tree/master</url>
    </scm>

    <!-- 开发人员信息 -->
    <developers>
        <developer>
            <name>xiaoxuetu</name>
            <email>xiaoxuetu@163.com</email>
            <organization>https://github.com/xiaoxuetu</organization>
            <timezone>+8</timezone>
        </developer>
    </developers>

    <!-- 发布管理信息 -->
    <distributionManagement>
        <repository>
            <!-- 这里的id必须要和全局配置中的release id 一致 -->
            <id>sonatype_releases</id>
            <name>Nexus Release Repository</name>
            <!-- 这里就是在创建issue成功后,对方回复的release发布地址-->
            <url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
        </repository>
        <snapshotRepository>
            <!-- 这里的id必须要和全局配置中的snapshot id 一致 -->
            <id>sonatype_snapshots</id>
            <name>Nexus Snapshot Repository</name>
            <!-- 这里就是在创建issue成功后,对方回复的snapshot发布地址-->
            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        </snapshotRepository>
    </distributionManagement>

2> 由于发布到maven中央仓库会要求我们在上传jar到同时,必须同步发布对应到Javadoc、source、asc(利用gpg生成到校验),所以需要在maven中添加以下构建插件

<build>
        <plugins>
            <plugin>
                <groupId>org.sonatype.plugins</groupId>
                <artifactId>nexus-staging-maven-plugin</artifactId>
                <version>1.6.7</version>
                <extensions>true</extensions>
                <configuration>
                    <!-- 这里的id必须要和全局配置中的release id 一致 -->
                    <serverId>sonatype_releases</serverId>
                    <nexusUrl>https://oss.sonatype.org/</nexusUrl>
                    <!-- 如果希望发布后自动执行close和release操作,此处可以调整为true -->
                    <autoReleaseAfterClose>false</autoReleaseAfterClose>
                </configuration>
            </plugin>

            <!-- 生成java source.jar -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>2.2.1</version>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <goals>
                            <goal>jar-no-fork</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

            <!-- 生成asc 校验文件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-gpg-plugin</artifactId>
                <version>1.5</version>
                <executions>
                    <execution>
                        <!-- 必须和配置中的gpg校验id一致 -->
                        <id>gpg</id>
                        <phase>verify</phase>
                        <goals>
                            <goal>sign</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

5、发布操作

1> 执行以下命令进行发布(如果 pom.xml 中autoReleaseAfterClose 的值为true,则脚本会自动完成在平台上close、release的操作,至此你将成功发布了,否则我们继续查看第2步)

 mvn clean javadoc:jar deploy -P release

2>登录https://oss.sonatype.org,然后选择staging Repositories

3> 如下图搜索并选择需要发布的组件,依次执行Close、Release操作

4> 如果Release成功,并且你是首次发布组件,则需要到你创建到issue中回复 “我已经成功发布该组件”,经历大概2小时后,该组件将会同步到对应的maven仓库

5> 如果Close或者Release不成功,你可以如下图操作查看原因并谷歌定位,或者回复咨询

四、参考文档

1>发布构件到 Maven 中央仓库遇到的坑:https://juejin.im/post/5cb03e1a5188251b0e4e3583

2>Working with PGP Signatures:https://central.sonatype.org/pages/working-with-pgp-signatures.html

3>Deploying to OSSRH with Apache Maven:https://central.sonatype.org/pages/apache-maven.html

到此这篇关于Maven中央仓库发布的实现方法的文章就介绍到这了,更多相关Maven中央仓库发布内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • 详解如何将JAR包发布到Maven中央仓库

    将jar包发布到Maven中央仓库(Maven Central Repository),这样所有的Java开发者都可以使用Maven直接导入依赖,例如fundebug-java: <!-- https://mvnrepository.com/artifact/com.fundebug/fundebug-java --> <dependency> <groupId>com.fundebug</groupId> <artifactId>fundebu

  • Maven发布封装到中央仓库时候报错:no default secret key

    今天因为发布swagger-spring-boot-starter做一个问题的修复,然后碰到了下面这个问题,记录一下解决过程,帮助后续碰到类似问题的童鞋: *gpg: WARNING: "--no-use-agent" is an obsolete option - it has no effect gpg: no default secret key: No secret key gpg: signing failed: No secret key 我们可以用gpg的命令来看一下当前

  • 如何把JAR发布到maven中央仓库的几种方法

    详细描述maven中央仓库发布jar包的中间过程, 以及遇到的一些问题汇总, 尽量用文字描述清楚, 耐心看下去, 就一定会发布成功 ----Sonatype篇---- 名词解释: Sonatype Nexus: Sonatype Nexus helps software development teams use open source so they can innovate faster and automatically control risk maven社区唯一指定的仓库地址为: ht

  • Maven中央仓库发布的实现方法

    目录 一.前言 二.环境准备 三.步骤说明 1.工单创建 2.gpg 环境安装 3.Maven全局配置 4.项目maven配置 5.发布操作 四.参考文档 一.前言 最近自己在学习Spring boot的过程中开发了一个组件 multithreadpool-spring-boot-starter,通过这个组件,我们可以动态根据配置文件进行多个线程池的初始化.既然有这个产出后,肯定是希望能够上传到maven中央仓库,给更多的人使用,于是就产生了这次项目发布经历. 整个过程可谓是一波三折,由于平时工

  • 使用CI/CD工具Github Action发布jar到Maven中央仓库的详细介绍

    之前发布开源项目Payment Spring Boot到Maven中央仓库我都是手动执行mvn deploy,在CI/CD大行其道的今天使用这种方式有点"原始".于是我一直在寻求一种能够支持流水线作业的发布工具,能让我在进行合并代码时自动触发构建发布.有一款免费的产品能做到这一点,它就是Github Action. Github Action Github Action是由Github创建的CI/CD服务. 它的目的是使所有软件开发工作流程的自动化变得容易. 直接从GitHub构建,测

  • Maven中央仓库正式成为Oracle官方JDBC驱动程序组件分发中心(推荐)

    1. 前言 相信参与使用Oracle数据库进行项目开发.运维的同学常常被Oracle JDBC驱动的Maven依赖折磨.现在这一情况在今年二月份得到了改变,甲骨文这个老顽固终于开窍了. 一位甲骨文的工程师发布博客:在Maven中央仓库中,现在不单单最新版本的Oracle JDBC驱动程序,而且还可以找到以往所有的Oracle JDBC驱动发行版,包括19.6.0.0.19.3.0.0.18.3.0.0.12.2.0.1和11.2.0.4.Maven中央仓库正式成为Oracle官方的JDBC驱动程

  • 上传自己的jar包到maven中央仓库的快速操作方法

    目录 (一)概述 (二)注册jira (三)发布申请 (四)发布项目 4.1 安装配置gpg 4.2 配置maven的setting.xml 4.3 配置pom文件 4.4 打包上传 (五)发布 (六)总结 (一)概述 现在网络上已经有不少上传jar包至中央仓库的教程,但是我搜了一大圈之后发现当时的做法目前并不适用,因此决定自己写下上传jar包至中央仓库的方式,写这篇文章的时间是2021年8月18日. (二)注册jira 本文档通过sonatype上传jar包至maven中央仓库,Sonatyp

  • 如何使用gradle将java项目推送至maven中央仓库

    目录 一.注册Sonatype账号申请创建项目 二.等待Sonatype申请批复 三.生成GPG 四.配置gradle 五.Sonatype将项目同步至Maven中央仓库 一.注册Sonatype账号申请创建项目 到链接:https://issues.sonatype.org/注册一个账号. 创建点击顶部导航栏的 create 创建项目 如上填写,注意的是group id我这里使用的是gitee的二级域名地址,这个域名必须是真实的,与project url中的一致.或者自己有一个域名按照提示的链

  • 手撸一个Spring Boot Starter并上传到Maven中央仓库

    目录 打包上传到中央仓库 第一步 在issues.sonatype.org注册一个账号 第二步 在issues.sonatype.org提交Issue 第三步 配置Maven Setting.xml 第四步 配置项目的pom.xml 第五步 安装和配置GPG 第六步 项目打包上传 第七步 处理验证 问题 我1.0.1版本发布错了,有办法修改或者删除吗? 先手撸一个Spring Boot Starter 准备搞个项目,包含以下几个功能后边还会加新功能. 配置项加密(已实现) 服务调用链 数据脱敏

  • Maven中央仓库地址配置大全

    在上一篇文章中完成了 <Maven镜像地址大全 >,后来又花了时间又去收集并整理了关于 maven 远程仓库地址,并整理于此,关于 Maven 远程仓库地址的配置方式有两种, 第一种:直接在项目的 pom.xml 文件中进行修改(不推荐,尤其是在多人协助的开发过程中非常的费事费力): 第二种:将 Maven 的远程仓库统一的配置到 Maven 的 Settings.xml 的配置文件中: Maven 中央仓库地址大全 1.阿里中央仓库(首推1) <repository> <i

  • 详解maven中央仓库连不上的解决办法

    方案一.使用国内的镜像阿里仓库等 首先通过maven的路径找到setting.xml的文件 然后在其中修改mirror和profile 保存一下就好了 方案二:https://maven.aliyun.com/mvn/search打开这个网站在里面下载你需要的jar包放到自己的本地仓库中 到此这篇关于详解maven中央仓库连不上的解决办法的文章就介绍到这了,更多相关maven中央仓库连不上内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

随机推荐