為 Kotlin Multiplatform 應用程式設定 GitHub Actions 持續整合
本指南展示了使用 GitHub Actions 設定 Kotlin Multiplatform 應用程式持續整合的範例。您將設定一個工作流 (workflow)，在每次推送 (push) 或提取要求 (pull request) 到 main 分支時，執行共用測試並針對 Android、iOS 和桌面平台建立建置產物。
本指南是以 Jetcaster KMP 範例 為基礎。您可以在 存儲庫中查看操作 (action) 與工作流配置，或按照以下步驟取得逐步說明。
本指南建議將 CI 設定分為兩個部分：
- 可重用的複合 GitHub 操作，用於設定 Java 與 Gradle
- 主要 GitHub Actions 工作流，在每次推送或提取要求到
main分支時執行測試並觸發特定平台的建置。
建立用於 Gradle 設定的複合操作
建立一個 複合操作 以在不同工作 (job) 之間同步 Java 與 Gradle 的配置。您將在工作流工作中重用此操作，以確保所有建置都使用相同的配置。
在此範例中，該操作會安裝 Java 17 並設定預設的 Gradle 版本。要設定該操作，請建立檔案 .github/actions/gradle-setup/action.yml：
name: gradle-setup
description: Setup Java and Gradle
runs:
using: "composite"
steps:
- name: Setup Java
uses: actions/[email protected]
with:
java-version: "17"
distribution: "temurin"
- name: Setup Gradle
uses: gradle/actions/[email protected]定義建置工作流
定義工作流的執行時機並設定 Gradle 選項：
- 工作流應在每次推送或提取要求到
main分支時執行。 - Gradle 選項應停用 Gradle daemon 並啟用具備快取的平行執行。
建立具備基礎配置的 .github/workflows/build.yml 檔案：
name: Build
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:
env:
GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx4096M -Dorg.gradle.daemon=false -Dorg.gradle.parallel=true -Dorg.gradle.caching=true"透過此配置，您還可以使用 workflow_dispatch 手動觸發工作流。
現在您可以新增工作來執行測試並建立應用程式建置產物。
執行共用測試
此工作使用 jvmTest Gradle 任務執行測試，以便在為所有平台建置應用程式之前驗證變更：
- 檢出要執行測試的存儲庫。
- 使用您先前準備的複合
gradle-setup操作來設定 Java 與 Gradle。 - 使用
./gradlew指令執行測試。 - 將測試報告作為產物上傳到
**/build/reports/tests/目錄。
要設定此工作，請將以下內容新增到 .github/workflows/build.yml 檔案中：
jobs:
test:
name: Run tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Gradle setup
uses: ./.github/actions/gradle-setup
- name: Run unit tests
run: ./gradlew jvmTest
- name: Upload test reports
uses: actions/upload-artifact@v4
with:
name: test-reports
path: "**/build/reports/tests/"執行測試後，工作流應建置應用程式產物。
建置 Android 偵錯套件
此工作使用 :mobile:assembleDebug Gradle 任務建置 Android 偵錯 APK：
- 檢出要建置套件的存儲庫。
- 使用您先前準備的複合
gradle-setup操作來設定 Java 與 Gradle。 - 使用
./gradlew指令建置 APK。 - 從
mobile/build/outputs/apk/debug/目錄上傳建置好的套件。
將以下內容新增至 .github/workflows/build.yml 檔案，接續在 jobs 區段之後：
jobs:
# ...
build-android:
name: Build Android
runs-on: ubuntu-latest
needs: test
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Gradle setup
uses: ./.github/actions/gradle-setup
- name: Build Android debug APK
run: ./gradlew :mobile:assembleDebug
- name: Upload Android debug APK
uses: actions/upload-artifact@v4
with:
name: android-apk
path: mobile/build/outputs/apk/debug/*.apk建置 iOS 模擬器應用程式
此工作以 iOS 模擬器 (Simulator) 為目標，以避免必須對應用程式進行正確簽署。該應用程式使用 xcodebuild 進行建置：
- 檢出要建置應用程式的存儲庫。
- 使用您先前準備的複合
gradle-setup操作來設定 Java 與 Gradle。 - 使用
xcodebuild建置 iOS 應用程式 —— 此範例展示了用於 Jetcaster KMP 範例的選項。 - 將包含建置好的應用程式資料夾（
build/Build/Products/Debug-iphonesimulator/*內的所有內容）作為產物上傳。
iOS 應用程式是在包含 xcodebuild 的 macOS 執行器 (macos-latest) 上建置的。
繼續修改 .github/workflows/build.yml 檔案：
jobs:
#...
build-ios:
name: Build iOS simulator app
runs-on: macos-latest
needs: test
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Gradle setup
uses: ./.github/actions/gradle-setup
- name: Build iOS simulator app
run: |
xcodebuild build \
-project JetcasterMigration/JetcasterMigration.xcodeproj \
-configuration Debug \
-scheme JetcasterMigration \
-sdk iphonesimulator \
-derivedDataPath ./build \
-verbose
- name: Upload app folder
uses: actions/upload-artifact@v4
with:
name: iphonesimulator-app
path: build/Build/Products/Debug-iphonesimulator/*推送並測試您的 CI
當您將工作流配置推送到 main 分支或使用這些設定檔建立提取要求時，CI 工作流將首次被觸發。
您可以在存儲庫的 Actions 索引標籤中查看工作流結果，以驗證一切是否正常運作。
請記住，您也可以手動觸發工作流：在左側的操作列表中選擇該工作流，然後點擊 Run workflow。
後續步驟
如需完整的 CI 配置範例，請參閱 Jetcaster 範例，該範例還包含為 macOS、Windows 和 Linux 建置桌面 JVM 應用程式的工作。
有關使用 GitHub Actions 將應用程式發佈到應用程式商店的指引，請參閱 Marco Gomiero 關於該主題的系列文章。