Skip to content

devops-publish-gradle-plugin.md

Latest commit

 

History

History
139 lines (103 loc) · 4.44 KB

devops-publish-gradle-plugin.md

File metadata and controls

139 lines (103 loc) · 4.44 KB

devops-publish-gradle-plugin

功能介绍

devops-publish-gradle-plugin是一个用于快速发布jar到maven中央仓库或私有maven仓库的gradle插件。

插件本身基于gradle官方推荐的maven-publish插件，我们在不破坏其本身用法的原则上，自动完成以下内容：

  • 添加maven-publish插件，该插件为gradle官方推荐的jar包发布插件
  • 添加signing签名插件，该插件为gradle官方推荐的jar包签名插件
  • 自动配置签名信息
  • 自动配置javaSource、javaDoc等publications
  • 自动配置发布仓库信息repositories，根据版本号自动选择repository
  • 自动补全manifest信息

devops-publish-gradle-plugin插件可以为我们解决以下问题：

  1. SONATYPE中央仓库对于jar包的规范十分严格，如manifest文件、pom信息、签名规范等，任何一个环节出错都会导致发布失败
  2. 远程仓库信息配置方式不统一
  3. GPG签名配置方式不统一

使用方式

对于需要发布到中央仓库或私服的module:

  • build.gradle.kts
plugins {
    id("com.tencent.devops.publish") version ${version}
}
  • build.gradle
plugins {
    id 'com.tencent.devops.publish' version ${version}
}

配置属性

优先级

为了适配ci流水线、本地开发等各种环境，且避免敏感信息泄露，插件会按照以下顺序查找配置(优先级越高越靠前)：

  1. 命令行变量
gradle -Dkey=value
  1. 环境变量
export key=value
  1. gradle.properties
key=value

远程仓库信息

属性 类型 默认值 说明
releaseRepoUrl string https://ossrh-staging-api.central.sonatype.com/service/local/ release仓库地址，默然为SONATYPE中央仓库地址
snapshotRepoUrl string https://central.sonatype.com/repository/maven-snapshots/ snapshot仓库地址，默然为SONATYPE中央仓库地址
repoUsername string null 仓库认证用户名
repoPassword string null 仓库认证密码

签名信息

属性 类型 默认值 说明
signingKey string null gpg签名key
signingKeyId string null gpg签名keyId
signingPassword string null gpg签名password

说明

  • 插件会读取project.version变量得到版本号，如果版本号以SNAPSHOT结尾，则使用snapshotRepoUrl进行发布，且不会执行签名，SONATYPE只会对release包进行签名校验。

  • 获取gpg 信息

    # secret key, signingKeyId取该值
gpg --armor --export-secret-key username@email --output private.key

# public key
gpg --armor --export username@email --output public.key

# keyId，取pub最后8位
gpg --list-keys

  • 自定义pom信息

    publishing {
  publications {
      withType<MavenPublication> {
          pom {
              name.set(project.name)
              description.set(project.description ?: project.name)
              url.set("https://github.com/Tencent/bk-ci")
              licenses {
                  license {
                      name.set("The MIT License (MIT)")
                      url.set("https://opensource.org/licenses/MIT")
                  }
              }
              developers {
                  developer {
                      name.set("bk-ci")
                      email.set("devops@tencent.com")
                      url.set("https://bk.tencent.com")
                      roles.set(listOf("Manager"))
                  }
              }
              scm {
                  connection.set("scm:git:git://github.com/Tencent/bk-ci.get")
                  developerConnection.set("scm:git:ssh://github.com/Tencent/bk-ci.git")
                  url.set("https://github.com/Tencent/bk-ci")
              }
          }
      }
  }
}

参考