Gradle + GitHub Actions 自动发布项目至 Maven 仓库

行走在赤道 2020-11-11 11:47:16
gradle 发布 github 自动 actions


摘要

文章内容核心是使用 Gradle 整合 GitHub Actions 自动化发布 Java 项目至 Maven 仓库。文章内是将项目发布至 sonatype 提供的仓库中。如果你需要自动化发布,或者需要将项目同步至 Maven 中央仓库请仔细阅读。

前期准备

  1. 可同步 Maven 中央仓库的门票,在 Issues Sonatype 上申请;
  2. OpenPGP 证书,需要同步至公共的服务器;
  3. 一个 Java Project;
  4. GitHub

关于同步门票部分可参考提供的链接,文章内主要叙述证书相关的内容。

OpenPGP 证书

因我使用的 Windows 操作系统这里使用 Gpg4win 工具生成同步证书。如果你使用的是 Mac 或者 Linux 操作系统可使用其它 GPG 工具如 GnuPG

安装 Gpg4win

下载地址 Gpg4win

生成证书

$ gpg --full-generate-key

运行上面的命令按照指示生成 RSA 的证书。

C:\Users\admin>gpg --full-generate-key
gpg (GnuPG) 2.2.23; Copyright (C) 2020 Free Software Foundation, Inc.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
... 省略部分 ...
public and secret key created and signed.
pub rsa3072 2020-11-10 [SC] [expires: 2021-11-10]
449B75F00B2DA482AB8D03E8493DA88E2B89E19F
uid kk70-blog (blog) <kevinz@weghst.com>
sub rsa3072 2020-11-10 [E] [expires: 2021-11-10]

浏览证书

可以使用 gpg --list-secret-keys --keyid-format SHORT 命令查询证书列表。

C:\Users\admin>gpg --list-secret-keys --keyid-format SHORT
C:/Users/admin/AppData/Roaming/gnupg/pubring.kbx
------------------------------------------------
sec rsa3072/2B89E19F 2020-11-10 [SC] [expires: 2021-11-10]
449B75F00B2DA482AB8D03E8493DA88E2B89E19F
uid [ultimate] kk70-blog (blog) <kevinz@weghst.com>
ssb rsa3072/6B7BF2DA 2020-11-10 [E] [expires: 2021-11-10]

发布证书

gpg --keyserver hkps.pool.sks-keyservers.net --send-keys 2B89E19F

使用 gpg 命令将证书发布到公共服务器 2B89E19F 替换为自己证书的 keyid。可在 http://keys.gnupg.net/ 网站搜索自己发布的证书。

Gradle 项目配置

配置 Gradle 插件

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

要使用 Gradle 发布依赖至 Maven 仓库你至少需要 maven-publish 插件。如果需要发布依赖至 Maven 中央仓库还需要使用 signing 插件对依赖文件进行签名验证。

Gradle Publish 配置

ext {
isReleasedVersion = !project.version.endsWith("-SNAPSHOT")
}
publishing {
publications {
mavenJava(MavenPublication) {
from components.java
artifact sourcesJar
artifact javadocJar
pom {
description = "Yein Chaos Core"
scm {
connection = "scm:git:git@github.com:kevin70/chaos.git"
developerConnection = "scm:git:ssh://github.com/kevin70/chaos.git"
url = "https://github.com/kevin70/chaos"
}
}
}
}
repositories {
maven {
credentials {
username findProperty("ossrhUsername") ?: System.getenv("OSSRH_USERNAME")
password findProperty("ossrhPassword") ?: System.getenv("OSSRH_PASSWORD")
}
if (!isReleasedVersion) {
url "https://oss.sonatype.org/content/repositories/snapshots"
} else {
url "https://oss.sonatype.org/service/local/staging/deploy/maven2"
}
}
}
}
  • isReleasedVersion 将快照版本与正式版本分开提交至不同的 Maven 仓库;
  • publishing.publications.mavenJava 需要同步的依赖资源;

    • artifact sourcesJar 需要发布的源码 jar 包;
    • artifact javadocJar 需要发布的 javadoc jar 包;
    • pom 自定义 pom.xml 文件内容。
  • publishing.repositories 发布的仓库配置;

    • maven.credentials Maven 仓库的认证信息;
    • maven.url Maven 仓库的 URL。

Gradle Singing 配置

signing {
sign publishing.publications.mavenJava
}

将需要发布的内容签名 https://docs.gradle.org/current/userguide/signing_plugin.html

这里默认采用 Signatory credentials 签名认证方式。

Github Actions 配置

首先在 GitHub Project > Settings > Secrets 中配置一些必要的参数。

Secret Parameters

以上的所有参数后面都会在 GitHub Workflow 中使用到。

  • OSSRH_USERNAME 是 sonatype 的登录用户名;
  • OSSRH_PASSWORD 是 sonatype 的登录密码;
  • SIGNING_KEY_ID 是 GPG 证书的 ID;
  • SIGNING_SECRET_KEY_RING_FILE 是 GPG 证书的的秘钥采用 BASE64 编码。

获取 SIGNING_KEY_ID

使用 gpg --list-secret-keys --keyid-format SHORT 命令获取 SIGNING_KEY_ID

$ gpg --list-secret-keys --keyid-format SHORT
C:\Users\admin>gpg --list-secret-keys --keyid-format SHORT
C:/Users/admin/AppData/Roaming/gnupg/pubring.kbx
------------------------------------------------
sec rsa3072/2B89E19F 2020-11-10 [SC] [expires: 2021-11-10]
449B75F00B2DA482AB8D03E8493DA88E2B89E19F
uid [ultimate] kk70-blog (blog) <kevinz@weghst.com>
ssb rsa3072/6B7BF2DA 2020-11-10 [E] [expires: 2021-11-10]

其中 2B89E19FSIGNING_KEY_ID

获取 SIGNING_SECRET_KEY_RING_FILE

将秘钥导出至文件 secring.gpg

$ gpg --export-secret-keys 2B89E19F > secring.gpg

将秘钥文件是二进制的我们需要将内容编码为 BASE64。因为我使用的 Windows 所以下面这个命令我是在 Git Bash 中运行的,如果你使用的 Mac 或 Linux 也可以直接运行如下的命令。

$ base64 secring.gpg > secring.gpg.b64

将编码好的文件 secring.gpg.b64 中的内容设置在 Secrets 中。

️ 因为我生成的证书未设置密码,所以这里缺少了 passphrase 配置,如果你的证书是有设置密码的需要额外增加 passphrase 的配置。

GitHub Secrets 设置完成,接下来编写 GitHub Action Workflow。

GitHub Action Workflow

name: Chaos CI with Gradle
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# 运行 JDK 配置
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: 11
# Gradle 缓存配置
- name: Cache Gradle packages
uses: actions/cache@v2
with:
path: ~/.gradle/caches
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
restore-keys: ${{ runner.os }}-gradle
# 给 gradlew 文件授权
- name: Grant execute permission for gradlew
run: chmod +x gradlew
# 构建项目
- name: Build with Gradle
run: ./gradlew build
# 将秘钥解码后将文件放置 ~/.gradle/secring.gpg
- name: Decode
run: |
echo "${{secrets.SIGNING_SECRET_KEY_RING_FILE}}" > ~/.gradle/secring.gpg.b64
base64 -d ~/.gradle/secring.gpg.b64 > ~/.gradle/secring.gpg
# 发布项目
- name: Publish
run: ./gradlew publish -Psigning.keyId=${{secrets.SIGNING_KEY_ID}} -Psigning.password= -Psigning.secretKeyRingFile=$(echo ~/.gradle/secring.gpg)
env:
OSSRH_USERNAME: ${{secrets.OSSRH_USERNAME}}
OSSRH_PASSWORD: ${{secrets.OSSRH_PASSWORD}}

当任务运行完成之后上 Maven 仓库中确认是否已经发布成功。


项目链接

https://github.com/kevin70/chaos

kk70 个人博客

版权声明
本文为[行走在赤道]所创,转载请带上原文链接,感谢
https://segmentfault.com/a/1190000037796593

  1. 【计算机网络 12(1),尚学堂马士兵Java视频教程
  2. 【程序猿历程,史上最全的Java面试题集锦在这里
  3. 【程序猿历程(1),Javaweb视频教程百度云
  4. Notes on MySQL 45 lectures (1-7)
  5. [computer network 12 (1), Shang Xuetang Ma soldier java video tutorial
  6. The most complete collection of Java interview questions in history is here
  7. [process of program ape (1), JavaWeb video tutorial, baidu cloud
  8. Notes on MySQL 45 lectures (1-7)
  9. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  10. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  11. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  12. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  13. 【递归,Java传智播客笔记
  14. [recursion, Java intelligence podcast notes
  15. [adhere to painting for 386 days] the beginning of spring of 24 solar terms
  16. K8S系列第八篇(Service、EndPoints以及高可用kubeadm部署)
  17. K8s Series Part 8 (service, endpoints and high availability kubeadm deployment)
  18. 【重识 HTML (3),350道Java面试真题分享
  19. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  20. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  21. [re recognize HTML (3) and share 350 real Java interview questions
  22. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  23. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  24. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  25. RPC 1: how to develop RPC framework from scratch
  26. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  27. RPC 1: how to develop RPC framework from scratch
  28. 一次性捋清楚吧,对乱糟糟的,Spring事务扩展机制
  29. 一文彻底弄懂如何选择抽象类还是接口,连续四年百度Java岗必问面试题
  30. Redis常用命令
  31. 一双拖鞋引发的血案,狂神说Java系列笔记
  32. 一、mysql基础安装
  33. 一位程序员的独白:尽管我一生坎坷,Java框架面试基础
  34. Clear it all at once. For the messy, spring transaction extension mechanism
  35. A thorough understanding of how to choose abstract classes or interfaces, baidu Java post must ask interview questions for four consecutive years
  36. Redis common commands
  37. A pair of slippers triggered the murder, crazy God said java series notes
  38. 1、 MySQL basic installation
  39. Monologue of a programmer: despite my ups and downs in my life, Java framework is the foundation of interview
  40. 【大厂面试】三面三问Spring循环依赖,请一定要把这篇看完(建议收藏)
  41. 一线互联网企业中,springboot入门项目
  42. 一篇文带你入门SSM框架Spring开发,帮你快速拿Offer
  43. 【面试资料】Java全集、微服务、大数据、数据结构与算法、机器学习知识最全总结,283页pdf
  44. 【leetcode刷题】24.数组中重复的数字——Java版
  45. 【leetcode刷题】23.对称二叉树——Java版
  46. 【leetcode刷题】22.二叉树的中序遍历——Java版
  47. 【leetcode刷题】21.三数之和——Java版
  48. 【leetcode刷题】20.最长回文子串——Java版
  49. 【leetcode刷题】19.回文链表——Java版
  50. 【leetcode刷题】18.反转链表——Java版
  51. 【leetcode刷题】17.相交链表——Java&python版
  52. 【leetcode刷题】16.环形链表——Java版
  53. 【leetcode刷题】15.汉明距离——Java版
  54. 【leetcode刷题】14.找到所有数组中消失的数字——Java版
  55. 【leetcode刷题】13.比特位计数——Java版
  56. oracle控制用户权限命令
  57. 三年Java开发,继阿里,鲁班二期Java架构师
  58. Oracle必须要启动的服务
  59. 万字长文!深入剖析HashMap,Java基础笔试题大全带答案
  60. 一问Kafka就心慌?我却凭着这份,图灵学院vip课程百度云