之前釋出開源專案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 Bootpom.xml。這裡只說一些關鍵的點,您需要:

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

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

Github Action Secrets

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

GPG的細節補充

這裡的 GPG_PASSWORDGPGPassphrase,網上Maven中央倉庫教程肯定會提這個,這裡不再細說。需要注意的是公鑰一定要上傳公鑰伺服器。

GPG_SECRET 獲取步驟如下:

  • 確定你有GPG環境,並按照其它教程配置好了GPG金鑰對。

  • 執行 gpg --list-secret-keys 檢視Key列表並複製你需要用的ID

  1. [root@192 ~]# gpg --list-secret-keys
  2. /root/.gnupg/pubring.kbx
  3. ------------------------
  4. sec rsa2048 2020-07-27 [SC]
  5. 8AC0AB86C34ADC6ED110A5A9E6730F4374866065
  6. uid felord (felord) <dax@felord.cn>
  • 執行gpg -a --export-secret-keys KEY_ID(KEY_ID為上圖中以8AC0AB開頭的字串)匯出私鑰,這裡需要輸入保護私鑰的密碼(GPG_PASSWORD)。然後會出現以下的密文:
  1. -----BEGIN PGP PRIVATE KEY BLOCK----
  2. ............密文區域.............
  3. -----END PGP PRIVATE KEY BLOCK-----

這就是``GPG_SECRET

修改專案的POM

然後修改專案的pom.xml檔案,模板我已經提出來了,不能修改的地方我已經寫了註釋:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5. <groupId>cn.felord</groupId>
  6. <artifactId>payment-spring-boot</artifactId>
  7. <version>1.0.9.RELEASE</version>
  8. <packaging>pom</packaging>
  9. <modelVersion>4.0.0</modelVersion>
  10. <name>payment-spring-boot</name>
  11. <description>wechat-pay and alipay sdk</description>
  12. <url>https://github.com/NotFound403/payment-spring-boot</url>
  13. <licenses>
  14. <license>
  15. <name>Apache License, Version 2.0</name>
  16. <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
  17. <distribution>repo</distribution>
  18. <comments>A business-friendly OSS license</comments>
  19. </license>
  20. </licenses>
  21. <developers>
  22. <developer>
  23. <name>felord</name>
  24. <email>felord@qq.com</email>
  25. <organization>felord.cn</organization>
  26. </developer>
  27. </developers>
  28. <scm>
  29. <tag>payment-spring-boot-1.0.9.RELEASE</tag>
  30. <url>https://github.com/NotFound403/payment-spring-boot</url>
  31. <connection>scm:git:https://github.com/NotFound403/payment-spring-boot.git</connection>
  32. <developerConnection>scm:git:https://github.com/NotFound403/payment-spring-boot.git</developerConnection>
  33. </scm>
  34. <profiles>
  35. <!-- Deployment profile (required so these plugins are only used when deploying) -->
  36. <!-- 下面這個標籤裡的不能改 -->
  37. <profile>
  38. <id>deploy</id>
  39. <build>
  40. <plugins>
  41. <plugin>
  42. <groupId>org.apache.maven.plugins</groupId>
  43. <artifactId>maven-source-plugin</artifactId>
  44. </plugin>
  45. <plugin>
  46. <groupId>org.apache.maven.plugins</groupId>
  47. <artifactId>maven-javadoc-plugin</artifactId>
  48. </plugin>
  49. <!-- GPG plugin -->
  50. <plugin>
  51. <groupId>org.apache.maven.plugins</groupId>
  52. <artifactId>maven-gpg-plugin</artifactId>
  53. </plugin>
  54. </plugins>
  55. </build>
  56. </profile>
  57. </profiles>
  58. <modules>
  59. <module>payment-spring-boot-autoconfigure</module>
  60. <module>payment-spring-boot-starter</module>
  61. </modules>
  62. <properties>
  63. <maven.compiler.source>1.8</maven.compiler.source>
  64. <maven.compiler.target>1.8</maven.compiler.target>
  65. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  66. <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  67. <java.version>1.8</java.version>
  68. <spring-boot.version>2.4.2</spring-boot.version>
  69. <aliy-pay-sdk.version>4.10.167.ALL</aliy-pay-sdk.version>
  70. <oss-starter.version>1.0.0.RELEASE</oss-starter.version>
  71. <lombok.verison>1.18.12</lombok.verison>
  72. <jackson.version>2.9.10</jackson.version>
  73. <bcprov.version>1.66</bcprov.version>
  74. <jackson.version>2.11.4</jackson.version>
  75. <httpclient.version>4.5.13</httpclient.version>
  76. </properties>
  77. <!-- 下面這個標籤裡的不能改 -->
  78. <distributionManagement>
  79. <repository>
  80. <id>ossrh</id>
  81. <name>Nexus Release Repository</name>
  82. <url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
  83. </repository>
  84. <snapshotRepository>
  85. <id>sonatype-nexus-snapshots</id>
  86. <name>Nexus Snapshot Repository</name>
  87. <url>https://oss.sonatype.org/content/repositories/snapshots</url>
  88. </snapshotRepository>
  89. </distributionManagement>
  90. <dependencyManagement>
  91. <dependencies>
  92. <!-- 你專案的依賴寫這裡-->
  93. </dependencies>
  94. </dependencyManagement>
  95. <!-- 下面這個標籤裡的不能改 -->
  96. <build>
  97. <pluginManagement>
  98. <plugins>
  99. <plugin>
  100. <groupId>org.apache.maven.plugins</groupId>
  101. <artifactId>maven-source-plugin</artifactId>
  102. <version>3.1.0</version>
  103. <executions>
  104. <execution>
  105. <phase>package</phase>
  106. <goals>
  107. <goal>jar-no-fork</goal>
  108. </goals>
  109. </execution>
  110. </executions>
  111. </plugin>
  112. <plugin>
  113. <groupId>org.apache.maven.plugins</groupId>
  114. <artifactId>maven-javadoc-plugin</artifactId>
  115. <version>3.2.0</version>
  116. <configuration>
  117. <show>private</show>
  118. <nohelp>true</nohelp>
  119. <charset>UTF-8</charset>
  120. <encoding>UTF-8</encoding>
  121. <docencoding>UTF-8</docencoding>
  122. </configuration>
  123. <executions>
  124. <execution>
  125. <phase>compile</phase>
  126. <goals>
  127. <goal>jar</goal>
  128. </goals>
  129. </execution>
  130. </executions>
  131. </plugin>
  132. <plugin>
  133. <groupId>org.apache.maven.plugins</groupId>
  134. <artifactId>maven-gpg-plugin</artifactId>
  135. <version>1.6</version>
  136. <executions>
  137. <execution>
  138. <id>sign-artifacts</id>
  139. <phase>verify</phase>
  140. <goals>
  141. <goal>sign</goal>
  142. </goals>
  143. <configuration>
  144. <!-- Prevent `gpg` from using pinentry programs -->
  145. <gpgArguments>
  146. <arg>--pinentry-mode</arg>
  147. <arg>loopback</arg>
  148. </gpgArguments>
  149. </configuration>
  150. </execution>
  151. </executions>
  152. </plugin>
  153. <plugin>
  154. <groupId>org.sonatype.plugins</groupId>
  155. <artifactId>nexus-staging-maven-plugin</artifactId>
  156. <version>1.6.8</version>
  157. <extensions>true</extensions>
  158. <configuration>
  159. <serverId>ossrh</serverId>
  160. <nexusUrl>https://oss.sonatype.org/</nexusUrl>
  161. <autoReleaseAfterClose>false</autoReleaseAfterClose>
  162. </configuration>
  163. </plugin>
  164. </plugins>
  165. </pluginManagement>
  166. <plugins>
  167. <plugin>
  168. <groupId>org.sonatype.plugins</groupId>
  169. <artifactId>nexus-staging-maven-plugin</artifactId>
  170. </plugin>
  171. </plugins>
  172. </build>
  173. </project>

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

編寫Github Action 指令碼

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

  1. # 相當於指令碼用途的一個宣告
  2. name: Maven Central Repo Deployment
  3. # 觸發指令碼的事件 這裡為釋出release之後觸發
  4. on:
  5. release:
  6. types: [released]
  7. # 定義一個發行任務
  8. jobs:
  9. publish:
  10. # 任務執行的環境
  11. runs-on: ubuntu-latest
  12. # 任務的步驟
  13. steps:
  14. # 1. 宣告 checkout 倉庫程式碼到工作區
  15. - name: Checkout Git Repo
  16. uses: actions/checkout@v2
  17. # 2. 安裝Java 環境 這裡會用到的引數就是 Git Action secrets中配置的,
  18. # 取值要在key前面加 secrets.
  19. - name: Set up Maven Central Repo
  20. uses: actions/setup-java@v1
  21. with:
  22. java-version: 1.8
  23. server-id: sonatype-nexus-staging
  24. server-username: ${{ secrets.OSSRH_USER }}
  25. server-password: ${{ secrets.OSSRH_PASSWORD }}
  26. gpg-passphrase: ${{ secrets.GPG_PASSWORD }}
  27. # 3. 釋出到Maven中央倉庫
  28. - name: Publish to Maven Central Repo
  29. # 這裡用到了其他人寫的action指令碼,詳細可以去看他的文件。
  30. uses: samuelmeuli/action-maven-publish@v1
  31. with:
  32. gpg_private_key: ${{ secrets.GPG_SECRET }}
  33. gpg_passphrase: ${{ secrets.GPG_PASSWORD }}
  34. nexus_username: ${{ secrets.OSSRH_USER }}
  35. nexus_password: ${{ secrets.OSSRH_PASSWORD }}

觸發Action

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

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

可以參考 Payment Spring Boot專案。

總結

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