Godot-Exporter
Godot Engine CI/CD Automation Pipeline For Public and Private Repositories
CI/CD Artifacts Example
Export Pipeline Platform Support
- Android
- iOS (XCode Project)
- Linux
- Mac OSX
- Windows Desktop
- HTML5
- UWP/Xbox (Work-In-Progress)
- Custom Engine Builds (Work-In-Progress)
Publishing Platform Integration
- Itch.io: (Android|Linux|MacOS|Windows|Web)
Action Environment Variables
- GODOT_VERSION: "3.3.2" | string (required)
- PROJECT_NAME: "GameFileName" | string (required)
- PROJECT_PATH: "gameDirectory" | string (required)
- EXPORT_MODE: "debug/release" | string (optional)
- IOS_ICON_PATH: "iconPath" | string (optional)
- ITCH_GAME: "ItchIoGameName" | string (required for publishing)
- ITCH_USER: "ItchIoUserName" | string (required for publishing)
- GAME_VERSION_TAG: "ProjectSettingDefinedPath" | string (required for versioning)
Action Environment Secrets
- BUTLER_CREDENTIALS: "xxx" | string (required for publishing)
- K8S_SECRET_RELEASE_KEYSTORE_BASE64: "xxx" | string (required in release mode)
- K8S_SECRET_RELEASE_KEYSTORE_USER: "xxx" | string (required in release mode)
- K8S_SECRET_RELEASE_KEYSTORE_PASSWORD: "xxx" | string (required in release mode)
Export Action Output Variables
- artifact-path: "Filepath to exported project file"
- export-settings: "Filepath to zip file containing used export_settings. (export_presets.cfg / editor_settings-3.tres)"
- exported-game-version: "Detected game version for CI / Store Publishing based on provided environment variable GAME_VERSION_TAG"
Environment Example
Create action file:
repository_name/.github/workflows/example.yml
name: "Godot Export Example"
on: [push, workflow_dispatch]
env:
GODOT_VERSION: 3.3.2
PROJECT_NAME: godot_exporter
PROJECT_PATH: game
EXPORT_MODE: release # If not defined, defaults to debug
# Required if in release mode
# K8S_SECRET_RELEASE_KEYSTORE_BASE64: ${{ secrets.K8S_SECRET_RELEASE_KEYSTORE_BASE64 }}
# K8S_SECRET_RELEASE_KEYSTORE_USER: ${{ secrets.K8S_SECRET_RELEASE_KEYSTORE_USER }}
# K8S_SECRET_RELEASE_KEYSTORE_PASSWORD: ${{ secrets.K8S_SECRET_RELEASE_KEYSTORE_PASSWORD }}
GAME_VERSION_TAG: game/version # Defined In Godot's Editor Project Settings - Path To Custom Variable
IOS_ICON_PATH: "icon_path"
ITCH_GAME: itchio-game
ITCH_USER: itchio-user
jobs:
export:
name: "Godot Project Export"
runs-on: ubuntu-latest
strategy:
matrix:
platform: [iOS, Android, Linux, MacOS, Windows, HTML5]
steps:
- name: Checkout
uses: actions/checkout@v2
# Export Godot Project
- name: Export ${{ matrix.platform }} Version
id: export
uses: vini-guerrero/godot-exporter/actions/export@master
with:
platform: ${{ matrix.platform }}
# Publish Platforms
- name: Publish Platforms
uses: vini-guerrero/godot-exporter/actions/publish@master
with:
platform: "Itch"
channel: ${{ matrix.platform }}
project_path: ${{ steps.export.outputs.artifact-path }}
# Upload Artifact
- uses: actions/upload-artifact@v1
with:
name: ${{ matrix.platform }}
path: ${{ steps.export.outputs.artifact-path }}