如何使用GitHub Action自動(dòng)發(fā)布JAR到Maven倉(cāng)庫(kù)
之前發(fā)布開源項(xiàng)目Payment Spring Boot[1]到 Maven 中央倉(cāng)庫(kù)我都是手動(dòng)執(zhí)行mvn deploy，在CI/CD大行其道的今天使用這種方式有點(diǎn)“原始”。于是我一直在尋求一種能夠支持流水線作業(yè)的發(fā)布工具，能讓我在進(jìn)行合并代碼時(shí)自動(dòng)觸發(fā)構(gòu)建發(fā)布。有一款免費(fèi)的產(chǎn)品能做到這一點(diǎn)，它就是Github Action。
Github Action
Github Action是由 Github 創(chuàng)建的CI/CD服務(wù)。它的目的是使所有軟件開發(fā)工作流程的自動(dòng)化變得容易。直接從 GitHub 構(gòu)建，測(cè)試和部署代碼。CI（持續(xù)集成）由很多操作組成，比如代碼合并、運(yùn)行測(cè)試、登錄遠(yuǎn)程服務(wù)器，發(fā)布到第三方服務(wù)等等。
今天我就嘗試用Github Action來將Payment Spring Boot[2]發(fā)布到 Maven 中央倉(cāng)庫(kù)。
期望效果
當(dāng)代碼庫(kù)發(fā)布Release(發(fā)行版)**的時(shí)候觸發(fā)一個(gè)將**Release所包含的分支發(fā)布到 Maven 中央倉(cāng)庫(kù)的效果。
Github中的Release發(fā)行版
?
拓展閱讀：
Release（發(fā)行版）是具有Changelogs（變更日志）和二進(jìn)制文件的一級(jí)對(duì)象，可以代表超出 Git 架構(gòu)本身的一個(gè)特定時(shí)間點(diǎn)之前的所有項(xiàng)目歷史。
前提條件
關(guān)于項(xiàng)目如何發(fā)布到 Maven 中央倉(cāng)庫(kù)及其一些必要的條件這里不再討論，網(wǎng)上有很多教程，有興趣的可以去搜索一下。也可以參考Payment Spring Boot[3]的pom.xml。這里只說一些關(guān)鍵的點(diǎn)，您需要：
OSSRH 賬號(hào)。 GPG 密鑰信息。
?
?? 注意：這兩個(gè)都是敏感數(shù)據(jù)不要泄露給其他人，否則你的項(xiàng)目將可能被其他人掌控。
Github Action Secrets
為了從Github Action發(fā)布，我們需要讓Github Action可以使用我們的 GPG 私鑰和 OSSRH 用戶信息。為了保證這些敏感信息的安全性，我們可以使用Github Action Secrets[4]來存儲(chǔ)它們。
GPG 的細(xì)節(jié)補(bǔ)充
這里的 GPG_PASSWORD為GPG的 Passphrase,網(wǎng)上 Maven 中央倉(cāng)庫(kù)教程肯定會(huì)提這個(gè)，這里不再細(xì)說。需要注意的是公鑰一定要上傳公鑰服務(wù)器。
GPG_SECRET 獲取步驟如下：
確定你有 GPG 環(huán)境，并按照其它教程配置好了 GPG 密鑰對(duì)。 執(zhí)行 gpg --list-secret-keys查看 Key 列表并復(fù)制你需要用的 ID
[root@192 ~]# gpg --list-secret-keys
/root/.gnupg/pubring.kbx
------------------------
sec rsa2048 2020-07-27 [SC]
8AC0AB86C34ADC6ED110A5A9E6730F4374866065
uid felord (felord) <[email protected]>
執(zhí)行 gpg -a --export-secret-keys KEY_ID(KEY_ID為上圖中以8AC0AB開頭的字符串)導(dǎo)出私鑰，這里需要輸入保護(hù)私鑰的密碼（GPG_PASSWORD）。然后會(huì)出現(xiàn)以下的密文：
-----BEGIN PGP PRIVATE KEY BLOCK----
............密文區(qū)域.............
-----END PGP PRIVATE KEY BLOCK-----
這就是GPG_SECRET。
修改項(xiàng)目的 POM
然后修改項(xiàng)目的pom.xml文件，模板我已經(jīng)提出來了，不能修改的地方我已經(jīng)寫了注釋：
<?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) -->
<!-- 下面這個(gè)標(biāo)簽里的不能改 -->
<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>
<lombok.verison>1.18.12</lombok.verison>
<jackson.version>2.9.10</jackson.version>
<bcprov.version>1.66</bcprov.version>
<jackson.version>2.11.4</jackson.version>
<httpclient.version>4.5.13</httpclient.version>
</properties>
<!-- 下面這個(gè)標(biāo)簽里的不能改 -->
<distributionManagement>
<repository>
<id>ossrh</id>
<name>Nexus Release Repository</name>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
</repository>
<snapshotRepository>
<id>sonatype-nexus-snapshots</id>
<name>Nexus Snapshot Repository</name>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
<dependencyManagement>
<dependencies>
<!-- 你項(xiàng)目的依賴寫這里-->
</dependencies>
</dependencyManagement>
<!-- 下面這個(gè)標(biāo)簽里的不能改 -->
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
<configuration>
<show>private</show>
<nohelp>true</nohelp>
<charset>UTF-8</charset>
<encoding>UTF-8</encoding>
<docencoding>UTF-8</docencoding>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
<configuration>
<!-- Prevent `gpg` from using pinentry programs -->
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.8</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>false</autoReleaseAfterClose>
</configuration>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
?
結(jié)合你自己的項(xiàng)目進(jìn)行必要的填充。
編寫 Github Action 腳本
Github Action腳本保存在項(xiàng)目根目錄下的.github/workflows路徑中。我們只需要編寫一個(gè)yaml來聲明執(zhí)行的步驟即可，具體的語(yǔ)法可以去看相關(guān)的中文文檔，這里只列出發(fā)布到Maven中央倉(cāng)庫(kù)的 action 腳本：
# 相當(dāng)于腳本用途的一個(gè)聲明
name: Maven Central Repo Deployment
# 觸發(fā)腳本的事件 這里為發(fā)布release之后觸發(fā)
on:
release:
types: [released]
# 定義一個(gè)發(fā)行任務(wù)
jobs:
publish:
# 任務(wù)運(yùn)行的環(huán)境
runs-on: ubuntu-latest
# 任務(wù)的步驟
steps:
# 1. 聲明 checkout 倉(cāng)庫(kù)代碼到工作區(qū)
- name: Checkout Git Repo
uses: actions/checkout@v2
# 2. 安裝Java 環(huán)境 這里會(huì)用到的參數(shù)就是 Git Action secrets中配置的，
# 取值要在key前面加 secrets.
- name: Set up Maven Central Repo
uses: actions/setup-java@v1
with:
java-version: 1.8
server-id: sonatype-nexus-staging
server-username: ${{ secrets.OSSRH_USER }}
server-password: ${{ secrets.OSSRH_PASSWORD }}
gpg-passphrase: ${{ secrets.GPG_PASSWORD }}
# 3. 發(fā)布到Maven中央倉(cāng)庫(kù)
- name: Publish to Maven Central Repo
# 這里用到了其他人寫的action腳本，詳細(xì)可以去看他的文檔。
uses: samuelmeuli/action-maven-publish@v1
with:
gpg_private_key: ${{ secrets.GPG_SECRET }}
gpg_passphrase: ${{ secrets.GPG_PASSWORD }}
nexus_username: ${{ secrets.OSSRH_USER }}
nexus_password: ${{ secrets.OSSRH_PASSWORD }}
觸發(fā) Action
都準(zhǔn)備完畢后，action 腳本要提交到Github，當(dāng)你使用release功能后會(huì)自動(dòng)在action一欄中執(zhí)行整個(gè)發(fā)布流程：
自動(dòng)發(fā)布到Maven中央倉(cāng)庫(kù)
這種方式一次配置，到處發(fā)布。我們不需要再關(guān)心怎么發(fā)布了，只需要關(guān)心在什么時(shí)候發(fā)布。
?
可以參考 Payment Spring Boot項(xiàng)目。
總結(jié)
今天通過對(duì)Github Action的簡(jiǎn)單使用來介紹了CI/CD的作用，這個(gè)技術(shù)體系是項(xiàng)目集成交付的趨勢(shì)，也是面試中的一個(gè)亮點(diǎn)技能。我是：碼農(nóng)小胖哥 多多關(guān)注分享更多有用的編程知識(shí)。多多關(guān)注、點(diǎn)贊、轉(zhuǎn)發(fā)、再看。
往期推薦
推薦關(guān)注本文作者：碼農(nóng)小胖哥
分享高質(zhì)量編程知識(shí)，探討IT人生
技術(shù)干貨，實(shí)戰(zhàn)技巧，面試技巧，前沿資訊一個(gè)都不能少
喜歡的這里報(bào)道
↘↘↘