构建 Godot 项目 GitHub 动作教程
项目介绍
build-godot-action
是一个 GitHub 动作,用于自动化构建 Godot 项目,支持多个平台(Linux、Windows 和 Mac)。该项目由 yeslayla 维护,旨在简化 Godot 项目的持续集成和部署流程。
项目快速启动
步骤 1:配置导出预设
在 Godot 中,为 Linux、Windows 和 Mac 创建导出模板。例如:
- Windows 导出名称应为
windows
,类型为Windows Desktop
- Mac 导出名称应为
mac
,类型为Mac OSX
- Linux 导出名称应为
linux
,类型为Linux/X11
确保 export_presets.cfg
文件位于与项目 Godot 文件相同的目录中,然后推送更改。
步骤 2:设置 GitHub 工作流
在仓库中添加以下工作流文件(例如 github/workflows/build.yml
):
name: Build Godot Project
on:
push: {}
pull_request: {}
jobs:
Godot:
runs-on: ubuntu-latest
strategy:
matrix:
platform: [linux, windows, mac]
steps:
- uses: actions/checkout@v2
with:
lfs: true
- name: Build
id: build
uses: yeslayla/build-godot-action@v1.5.0
with:
name: example
preset: ${{ matrix.platform }}
debugMode: "true"
- name: Upload Artifact
uses: actions/upload-artifact@v2
with:
name: Client - ${{ matrix.platform }}
path: ${{ github.workspace }}/${{ steps.build.outputs.build }}
应用案例和最佳实践
应用案例
- 游戏开发团队:使用
build-godot-action
自动化游戏构建过程,确保每次提交都能生成可执行文件,便于测试和发布。 - 开源项目:开源 Godot 项目可以利用此动作简化贡献者的工作流程,自动构建和上传构建结果。
最佳实践
- 版本控制:始终使用最新版本的
build-godot-action
,以确保兼容性和安全性。 - 错误处理:在工作流中添加错误处理步骤,确保构建失败时能够及时通知开发者。
- 文档完善:详细记录每个步骤和配置,便于团队成员理解和维护。
典型生态项目
- Godot 引擎:
build-godot-action
是 Godot 引擎生态系统的一部分,与 Godot 引擎紧密集成。 - GitHub Actions:该项目充分利用 GitHub Actions 的功能,提供自动化构建和部署解决方案。
- 持续集成工具:与 Jenkins、Travis CI 等持续集成工具相比,GitHub Actions 提供了更简洁的集成方式。
通过以上步骤和实践,您可以高效地使用 build-godot-action
自动化构建 Godot 项目,提升开发效率和项目质量。