您好,登錄后才能下訂單哦!
這篇文章主要講解了“如何使用CI/CD工具Github Action發布jar到Maven中央倉庫”,文中的講解內容簡單清晰,易于學習與理解,下面請大家跟著小編的思路慢慢深入,一起來研究和學習“如何使用CI/CD工具Github Action發布jar到Maven中央倉庫”吧!
之前發布開源項目Payment Spring Boot到Maven中央倉庫我都是手動執行mvn deploy
,在CI/CD大行其道的今天使用這種方式有點“原始”。于是我一直在尋求一種能夠支持流水線作業的發布工具,能讓我在進行合并代碼時自動觸發構建發布。有一款免費的產品能做到這一點,它就是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發布,我們需要讓Github Action可以使用我們的GPG私鑰和OSSRH用戶信息。為了保證這些敏感信息的安全性,我們可以使用Github Action Secrets來存儲它們。
這里的 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.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/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腳本要提交到Github,當你使用release
功能后會自動在action
一欄中執行整個發布流程:
這種方式一次配置,到處發布。我們不需要再關心怎么發布了,只需要關心在什么時候發布。
可以參考 Payment Spring Boot項目。
今天通過對Github Action的簡單使用來介紹了CI/CD的作用,這個技術體系是項目集成交付的趨勢,也是面試中的一個亮點技能。 而且這種方式可以實現“一次配置,隨時隨地集成部署”。
感謝各位的閱讀,以上就是“如何使用CI/CD工具Github Action發布jar到Maven中央倉庫”的內容了,經過本文的學習后,相信大家對如何使用CI/CD工具Github Action發布jar到Maven中央倉庫這一問題有了更深刻的體會,具體使用情況還需要大家實踐驗證。這里是億速云,小編將為大家推送更多相關知識點的文章,歡迎關注!
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。