使用CI/CD工具Github Action釋出jar到Maven中央倉庫

碼農小胖哥發表於2021-07-09
GithubJARMaven

之前釋出開源專案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中央倉庫的效果。

Github中的Release發行版

擴充閱讀：

Release（發行版）是具有 Changelogs（變更日誌）和二進位制檔案的一級物件，可以代表超出 Git 架構本身的一個特定時間點之前的所有專案歷史。

前提條件

關於專案如何釋出到Maven中央倉庫及其一些必要的條件這裡不再討論，網上有很多教程，有興趣的可以去搜尋一下。也可以參考Payment Spring Boot的pom.xml。這裡只說一些關鍵的點，您需要：

  • OSSRH賬號。
  • GPG金鑰資訊。

?注意：這兩個都是敏感資料不要洩露給其他人，否則你的專案將可能被其他人掌控。

Github Action Secrets

為了從Github Action釋出，我們需要讓Github Action可以使用我們的GPG私鑰和OSSRH使用者資訊。為了保證這些敏感資訊的安全性，我們可以使用Github Action Secrets來儲存它們。

image-20210322231312988

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) <dax@felord.cn>
  • 執行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>felord@qq.com</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>
        <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>

    <!-- 下面這個標籤裡的不能改 -->
    <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>
            <!-- 你專案的依賴寫這裡-->
        </dependencies>
    </dependencyManagement>
         <!-- 下面這個標籤裡的不能改 -->
    <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>

結合你自己的專案進行必要的填充。

編寫Github Action 指令碼

Github Action指令碼儲存在專案根目錄下的.github/workflows路徑中。我們只需要編寫一個yaml來宣告執行的步驟即可，具體的語法可以去看相關的中文文件，這裡只列出釋出到Maven中央倉庫的action指令碼：

# 相當於指令碼用途的一個宣告
name: Maven Central Repo Deployment
# 觸發指令碼的事件  這裡為釋出release之後觸發
on:
  release:
    types: [released]
# 定義一個發行任務
jobs:
  publish:
# 任務執行的環境
    runs-on: ubuntu-latest
# 任務的步驟
    steps:
# 1. 宣告 checkout 倉庫程式碼到工作區
      - name: Checkout Git Repo
        uses: actions/checkout@v2
# 2. 安裝Java 環境 這裡會用到的引數就是 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. 釋出到Maven中央倉庫
      - name: Publish to Maven Central Repo
# 這裡用到了其他人寫的action指令碼，詳細可以去看他的文件。
        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 }}

觸發Action

都準備完畢後，action指令碼要提交到Github，當你使用release功能後會自動在action一欄中執行整個釋出流程：

自動釋出到Maven中央倉庫

這種方式一次配置，到處釋出。我們不需要再關心怎麼釋出了，只需要關心在什麼時候釋出。

可以參考 Payment Spring Boot專案。

總結

今天通過對Github Action的簡單使用來介紹了CI/CD的作用，這個技術體系是專案整合交付的趨勢，也是面試中的一個亮點技能。 而且這種方式可以實現“一次配置，隨時隨地整合部署”。

相關文章