之前发布开源项目
Payment Spring Boot
到Maven中央仓库我都是手动执行
mvn deploy
,在
CI/CD
大行其道的今天使用这种方式有点“原始”。于是我一直在寻求一种能够支持流水线作业的发布工具,能让我在进行合并代码时自动触发构建发布。有一款免费的产品能做到这一点,它就是
Github Action
。
Github Action
Github Action 是由Github创建的 CI/CD 服务。 它的目的是使所有软件开发工作流程的自动化变得容易。 直接从GitHub构建,测试和部署代码。CI(持续集成)由很多操作组成,比如代码合并、运行测试、登录远程服务器,发布到第三方服务等等。
今天我就尝试用 Github Action 来将 Payment Spring Boot 发布到Maven中央仓库。
期望效果
当代码库发布 Release(发行版) 的时候触发一个将 Release 所包含的分支发布到Maven中央仓库的效果。
拓展阅读:
Release(发行版)
是具有Changelogs
(变更日志)和二进制文件的一级对象,可以代表超出 Git 架构本身的一个特定时间点之前的所有项目历史。
前提条件
关于项目如何发布到Maven中央仓库及其一些必要的条件这里不再讨论,网上有很多教程,有兴趣的可以去搜索一下。也可以参考
Payment Spring Boot
的
pom.xml
。这里只说一些关键的点,您需要:
- OSSRH账号。
- GPG密钥信息。
💡注意:这两个都是敏感数据不要泄露给其他人,否则你的项目将可能被其他人掌控。
Github Action Secrets
为了从 Github Action 发布,我们需要让 Github Action 可以使用我们的GPG私钥和OSSRH用户信息。为了保证这些敏感信息的安全性,我们可以使用 Github Action Secrets 来存储它们。
GPG的细节补充
这里的
GPG_PASSWORD
为
GPG
的
Passphrase
,网上Maven中央仓库教程肯定会提这个,这里不再细说。需要注意的是公钥一定要上传公钥服务器。
GPG_SECRET
获取步骤如下:
-
确定你有GPG环境,并按照其它教程配置好了GPG密钥对。
-
执行
gpg --list-secret-keys
查看Key列表并复制 你需要用的ID
[root@192 ~]# gpg --list-secret-keys
/root/.gnupg/pubring.kbx
------------------------
sec rsa2048 2020-07-27 [SC]
8AC0AB86C34ADC6ED110A5A9E6730F4374866065
uid felord (felord) <[email protected]>
复制代码
-
执行
gpg -a --export-secret-keys KEY_ID
(KEY_ID
为上图中以8AC0AB
开头的字符串)导出私钥,这里需要输入保护私钥的密码(GPG_PASSWORD
)。然后会出现以下的密文:
-----BEGIN PGP PRIVATE KEY BLOCK----
............密文区域.............
-----END PGP PRIVATE KEY BLOCK-----
复制代码
这就是``GPG_SECRET
。
修改项目的POM
然后修改项目的
pom.xml
文件,模板我已经提出来了,不能修改的地方我已经写了注释:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<groupId>cn.felord</groupId>
<artifactId>payment-spring-boot</artifactId>
<version>1.0.9.RELEASE</version>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
<name>payment-spring-boot</name>
<description>wechat-pay and alipay sdk</description>
<url>https://github.com/NotFound403/payment-spring-boot</url>
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
<comments>A business-friendly OSS license</comments>
</license>
</licenses>
<developers>
<developer>
<name>felord</name>
<email>[email protected]</email>
<organization>felord.cn</organization>
</developer>
</developers>
<scm>
<tag>payment-spring-boot-1.0.9.RELEASE</tag>
<url>https://github.com/NotFound403/payment-spring-boot</url>
<connection>scm:git:https://github.com/NotFound403/payment-spring-boot.git</connection>
<developerConnection>scm:git:https://github.com/NotFound403/payment-spring-boot.git</developerConnection>
</scm>
<profiles>
<!-- Deployment profile (required so these plugins are only used when deploying) -->
<!-- 下面这个标签里的不能改 -->
<profile>
<id>deploy</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
<!-- GPG plugin -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
</plugin>
</plugins>
</build>
</profile>
</profiles>
<modules>
<module>payment-spring-boot-autoconfigure</module>
<module>payment-spring-boot-starter</module>
</modules>
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-boot.version>2.4.2</spring-boot.version>
<aliy-pay-sdk.version>4.10.167.ALL</aliy-pay-sdk.version>
<oss-starter.version>1.0.0.RELEASE</oss-starter.version