godot-ci

Docker镜像，用于导出Godot Engine游戏并部署到GitLab/GitHub Pages和Itch.io，支持通过GitLab CI和GitHub Actions实现自动化流程。

!godot-ci

Docker Hub

[***]

使用方法

本项目包含 .gitlab-ci.yml 和 .github/workflows/godot-ci.yml 作为配置参考。
有关使用此模板的实际项目、示例和教程，请查看以下列表：

• Kyle Luce 的视频教程
• David Snopek 的视频教程系列
• 仓库示例：test-project | game-off
• 使用此工具的测试部署：GitHub Pages | GitLab Pages | Itch.io

Mono/C#

若要构建启用Mono的Godot项目，需在 .gitlab-ci.yml（GitLab）或 godot-ci.yml（GitHub）中将镜像标签从 barichello/godot-ci:VERSION 更改为 barichello/godot-ci:mono-VERSION。例如：barichello/godot-ci:mono-3.2.1。

Android

构建调试版本（debug.keystore），可使用 .gitlab-ci.yml 文件中的 android_debug 任务示例。

若要使用自定义密钥库导出Android版本，步骤如下：

1. 将生成的密钥库转换为Base64格式：
   Linux & macOS：base64 release.keystore -w 0
   Windows：certutil -encodehex -f release.keystore encoded.txt 0x40000001
2. 进入 GitLab项目 > 设置 > CI/CD > 变量，将Base64编码的密钥库值作为新变量 SECRET_RELEASE_KEYSTORE_BASE64（类型为变量）添加。
3. 创建第二个变量 SECRET_RELEASE_KEYSTORE_USER（类型为变量），值为密钥库别名。
4. 创建第三个变量 SECRET_RELEASE_KEYSTORE_PASSWORD（类型为变量），值为密钥库密码。
5. 使用 .gitlab-ci.yml 文件中的 android 任务示例。

GDNative/C++

有关GDNative C++编译自动化，可参考基于此仓库的 godot-cpp-ci 仓库。

Modules

需先编译包含模块的Godot引擎。可参考Calinou的 godot-builds-ci 仓库实现Godot构建自动化。

之后，使用自定义构建照常导出项目。可参考Greenfox的 指南 了解如何将自定义Godot构建用于自动化导出。

iOS

暂不支持。Xcode项目自动化虽可行但复杂，且GitHub Actions最近才支持macOS运行器，未来将逐步支持。

支持的CI服务与平台

以下是各支持的CI服务、模板任务及实际示例的对应关系。

环境配置

首先，从用作模板的 .yml 文件（.gitlab-ci.yml 或 .github/workflows/godot-ci.yml）中移除未使用的任务/阶段。
然后，根据所选CI和任务，在配置面板中添加以下环境变量：

• GitHub：[***]<用户名>/<项目名>/settings/secrets
• GitLab：[***]<用户名>/<仓库名>/settings/ci_cd

GitHub Pages 所需变量

其他变量由 gitlab-runner 自动设置，详见 预定义变量文档。

Itch.io 所需变量（基于Butler）

部署到Itch.io通过 Butler 实现。所需变量：

故障排除

导出问题

• 检查 export_presets.cfg 中的导出名称是否与CI脚本中使用的名称匹配。
• 检查CI脚本中的路径，若项目放在文件夹中（如 test-project 模板），部分命令可能因路径错误无法运行。

Butler认证错误

• 若使用GitLab，检查 CI/CD变量面板 中“保护”标签是否已禁用。

额外资源

Greenfox的 godot-build-automation 仓库同样用于Godot导出自动化，内容丰富。