This is a fork of abarichello/godot-ci for Godot 4 beta
Docker image to export Godot 4 Beta games and deploy to GitLab/GitHub Pages and Itch.io using GitLab CI and GitHub Actions.
https://hub.docker.com/r/benpm/godot-4-ci/
.gitlab-ci.yml and .github/workflows/godot-4-ci.yml are included in this project as reference.
First you need to remove unused jobs/stages from the .yml file you are using as a template(.gitlab-ci.yml or .github/workflows/godot-4-ci.yml).
Then you have to add these environments to a configuration panel depending on the chosen CI and jobs:
- GitHub:
https://github.com/<username>/<project-name>/settings/secrets - GitLab:
https://gitlab.com/<username>/<repo-name>/settings/ci_cd
Secrets needed for a GitHub Pages deploy via GitLab CI:
| Variable | Description | Example |
|---|---|---|
| REMOTE_URL | The git remote where the web export will be hosted (in this case GitHub), it should contain your deploy/personal access token |
https://<github username>:<deploy token>@github.com/<username>/<repository>.git |
| GIT_EMAIL | Git email of the account that will commit to the gh-pages branch. |
email@example.com |
| GIT_USERNAME | Username of the account that will commit to the gh-pages branch. |
username |
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:
| Variable | Description | Example |
|---|---|---|
| ITCHIO_USERNAME | Your username on Itch.io, as in your personal page will be at https://<username>.itch.io |
username |
| ITCHIO_GAME | the name of your game on Itchio, as in your game will be available at https://<username>.itch.io/<game> |
game |
| 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 Masked(GitLab CI) to keep it secret |
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
- Check that the export presets file (
export_presets.cfg) is committed to version control. In other words,export_presets.cfgmust not be in.gitignore.- Make sure you don't accidentally commit Android release keystore or Windows codesigning credentials. These credentials cannot be revoked if they are leaked!
- Check that the export names on
export_presets.cfgmatch the ones used in your CI script (case-sensitive). Export preset names that contain spaces must be written within quotes (single or double). - Check the paths used in your CI script. Some commands may be running in the wrong place if you are keeping the project in a folder (like the
test-projecttemplate) or not.
Greenfox has an excellent repo that is also for automating Godot exports.