Docker image to export Godot Engine games and deploy to GitLab/GitHub Pages and Itch.io using GitLab CI and GitHub Actions.
.github/workflows/godot-ci.yml are included in this project as reference.
For live projects, examples and tutorials using this template check the list below:
To build a godot project with Mono enabled, change the image tag from
.gitlab-ci.yml (Gitlab) or
godot-ci.yml (Github). e.g.
To build a debug release (debug.keystore), use the
android_debug job example in the
If you want to export for Android with your own keystore, you can do this with the following steps:
base64 release.keystore -w 0Windows:
certutil -encodehex -f release.keystore encoded.txt 0x40000001
SECRET_RELEASE_KEYSTORE_BASE64as type variable.
androidjob example in the
See this repository for automating GDNative C++ compilation, which is based off this repository.
You have to compile Godot with the modules included first. See this excellent repository by Calinou for automating Godot builds.
After that, you would use the custom build to export your project as usual. See this guide by Greenfox on how to use a custom Godot build for automated exports.
Not available yet. Automating Xcode projects is doable but not trivial, and macOS runners only recently became available for GitHub actions, so it will happen eventually.
Here's a mapping between each supported CI service, the template jobs and a live example.
|GitLab CI||Godot Exports / GitHub Pages / GitLab Pages / Itch.io||GitLab CI Pipelines|
|GitHub Actions||Godot Exports||GitHub Actions running|
First you need to remove unused jobs/stages from the
.yml file you are using as a template(
Then you have to add these environments to a configuration panel depending on the chosen CI and jobs:
Secrets needed for a GitHub Pages deploy via GitLab CI:
|GIT_EMAIL||Git email of the account that will commit to the
|GIT_USERNAME||Username of the account that will commit to the
Others variables are set automatically by the
gitlab-runner, see the documentation for predefined variables.
Deployment to Itch.io is done via Butler.
Secrets needed for a Itch.io deploy via GitLab CI:
|ITCHIO_USERNAME||Your username on Itch.io, as in your personal page will be at
|ITCHIO_GAME||the name of your game on Itchio, as in your game will be available at
|BUTLER_API_KEY||An Itch.io API key is necessary for Butler so that the CI can authenticate on Itch.io on your behalf. Make that API key
export_presets.cfgmatch the ones used in your CI script.
test-projecttemplate) or not.
Greenfox has an excellent repo that is also for automating Godot exports.