Unity Actions GitHub 工作流指南
1. 项目介绍
Unity Actions 是一个 GitHub Action,用于自动化 Unity 游戏引擎的工作流程。它允许开发者在GitHub上构建、测试和发布Unity项目,直接集成到持续集成(CI)和持续部署(CD)流程中。通过这个工具,你可以轻松地配置和执行常见的Unity命令,如编译、运行测试或打包游戏。
2. 项目快速启动
要开始使用 Unity Actions,你需要在你的GitHub仓库中创建一个新的.github/workflows
目录,并在其中添加一个YAML文件,例如build.yml
。以下是一个简单的示例配置:
name: Unity Build and Test
on:
push:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Unity Hub
uses: game-ci/unity-hub-action@v1
with:
unityVersion: '2020.3.25f1' # 替换为你所需的Unity版本号
- name: Setup Unity Project
uses: game-ci/unity-action@v1
with:
workingDirectory: './MyUnityProject' # 指向你的Unity项目根目录
unityVersion: ${{ steps.setup-unity-hub.outputs.unityVersion }}
args: '-batchmode -nographics -logFile -executeMethod BuildScript.BuildPlayer'
这段代码会在每次向main
分支推送时触发一个名为build
的作业,该作业将检查代码、设置Unity Hub并运行Unity项目中的指定方法(这里是BuildScript.BuildPlayer
),用于构建游戏。
3. 应用案例和最佳实践
3.1 自动化测试
在工作流中加入测试步骤以确保每次更新代码后都能通过所有测试:
- name: Run Unit Tests
env:
CI: true
run: |
cd MyUnityProject
./Editor/Tests/RunTests.sh
3.2 部署到多个平台
你可以配置不同的工作流步骤来构建不同平台的游戏,比如iOS、Android或WebGL:
- name: Build for iOS
if: runner.os == 'macOS'
run: |
cd MyUnityProject
unity-editor -batchmode -nographics -executeMethod BuildScript.BuildIos
3.3 版本控制
使用环境变量跟踪和更新构建版本:
env:
BUILD_NUMBER: ${{ github.run_number }}
- name: Update Version
run: |
sed -i '' -e "s/<version>.*<\/version>/<version>${BUILD_NUMBER}<\/version>/" Assets/manifest.json
4. 典型生态项目
Unity Actions 得益于整个GitHub社区,许多开发者和团队已经分享了他们基于此工具的复杂工作流程示例。例如:
- Unity CI Showcase - 展示各种使用Unity Actions进行CI/CD配置的例子。
- Unity Package Manager Examples - Unity官方的包管理器UI项目使用的GitHub Actions。
这些项目可以作为参考,帮助你在自己的Unity项目中实现更丰富的自动化功能。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考