MavenCentral库发布记录

news2024/11/18 17:28:39

最近发布了 Android 路由库 URouter，支持 AGP8、ActivityResult启动等特性。
把提交到 Maven Central 过程记录一下。

一、注册 Sonatype 账号，新建项目

登录后，新建项目：

二、准备 GPG 密钥

GPG 来生成密钥，安装 GPG
Windows下使用scoop安装：

scoop install gpg

gpg --generate-key

gpg --list-keys

这里获取到pub公钥，

在这里插入图片描述

创建完成，–list-keys 显示 pub 第二方一串：
67E95C8F2931C822********************F7E9
后面用于 上传和验证公钥

上传公钥

gpg --keyserver hkp://keyserver.ubuntu.com:11371 --send-keys 
67E95C8F2931C822********************F7E9

# 验证是否上传功能，后 8 位即可
gpg --keyserver hkp://keyserver.ubuntu.com:11371 --recv-keys ****F7E9

导出密钥，后面签名用

gpg --export-secret-keys 67E95C8F2931C822********************F7E9 > secret.gpg

三、Gradle项目配置

本地发布和远程发布，需要 maven-publish 插件，
GPG为了签名，需要 signing 插件。项目模块 build.gradle 配置：

plugins {
    id 'maven-publish'
    id 'signing'
}

添加后，gradle 就多了 publish 任务：

在这里插入图片描述

配置发布

添加maven-publish后，开始配置 publishing 代码块

// 配置发布后 groupId，默认 artifactId 是项目模块名
group = 'org.example'
version = '1.0'

task sourcesJar(type: Jar) {
    classifier = 'sources'
    from sourceSets.main.allSource
}

task javadocJar(type: Jar) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

publishing {
    publications {
        release(MavenPublication) {
            // 配置POM信息
            pom {
                name = project.name
                description = 'xxx'
                url = 'https://github.com/xxx/xxx'
                // 开源协议
                licenses {
                    license {
                        name = 'The Apache License, Version 2.0'
                        url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                    }
                }

                // 配置开发者信息
                developers {
                    developer {
                        id = 'xxx'
                        name = 'xxx'
                        email = 'xxx@163.com'
                    }
                }

                // scm
                scm {
                    connection = 'https://github.com/xxx/xxx.git'
                    developerConnection = 'https://github.com/xxx/xxx.git'
                    url = 'https://github.com/xxx/xxx'
                }
            }

            // 发布文档 JAR
            artifact javadocJar
            // 发布源码 JAR
            artifact sourcesJar

            from components.java
        }
    }

    repositories {
        maven {
            url "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/"
            credentials {                
                username project.sonaUsername // sonatype username
                password project.sonaPassword // sonatype password
            }
        }
    }
}

signing {
    sign publishing.publications.release
}

配置 sonatype 账号和 GPG密钥

上面配置，还不能直接使用，在 gradle.properties 配置用到的变量：

对于密码信息，可以放到用户目录下的 gradle.properties，
Windows下是：

C:\Users\用户名\.gradle\gradle.properties

添加账号信息：

# sonatype 账号信息
sonaUsername=xxxx
sonaPassword=xxxx
# GPG Signing Info
signing.keyId=XXXXXXXX
signing.password=xxxxxx
# 上面导出的 GPG 密钥路径
signing.secretKeyRingFile=C:\\Users\\username\\.gpg\\secret.gpg