https://github.com/rakkarage/auto
GitHub workflow to build and deploy Godot project.
https://github.com/rakkarage/auto
automation build deploy github godot godot-engine workflow
Last synced: about 2 months ago
JSON representation
GitHub workflow to build and deploy Godot project.
- Host: GitHub
- URL: https://github.com/rakkarage/auto
- Owner: rakkarage
- License: unlicense
- Created: 2024-09-18T19:23:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-02T22:45:44.000Z (over 1 year ago)
- Last Synced: 2025-02-13T19:21:53.517Z (over 1 year ago)
- Topics: automation, build, deploy, github, godot, godot-engine, workflow
- Homepage:
- Size: 281 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gobot
This workflow is designed to automate the process of building and deploying Godot projects.
## Features
- Caches Godot and templates, so only downloads once.
- Parses build settings from `export_presets.cfg` to generates a custom strategy matrix to run all builds concurrently.
- Do not need to set file names or paths just have the platform present in the file.
- Will use your file and extension names if set. Except web which will use `index.htm` to deploy correctly.
- If have wrong `Linux`/`Linux/X11` platform name for supplied version in `export_presets.cfg`, will rewrite it.
- Deploys web artifact to the repository GitHub Pages environment.
- Optionally deletes old repository GitHub Pages deployments.
- This only really works with Godot >= 4.3 (and some 3.x versions for a while)
> [!WARNING]
> Old repository GitHub Pages deployments can be deleted.
## Workflow Overview
## Inputs
- `godot-version`: The version of Godot to be used in the build. This is required by called workflow. Caller workflow can set a default.
- `environment`: The GitHub Pages environment to deploy the web build to. This is required by called workflow. Caller workflow can set a default.
- `delete-old-pages`: Delete old Pages deployments or not. This is required by called workflow. Caller workflow can set a default.
## Jobs
1. **Setup**
- Analyze input to generate a dynamic build matrix, and Cache Godot and Export Templates.
3. **Build**
- Export the project for each target platform concurrently.
5. **Deploy**
- Deploy web build to Pages after optionally deleting old Pages deployments.
## Usage
Ensure build platforms are defined in export_settings.cfg
If you have a web build, enable `Build and Deployment from GitHub Actions` in repo/settings/pages.
To use the workflow, call it from another workflow using (for example) the `workflow_call` event and provide the required inputs:
Files:
- `gobot.yml`: This is the **reusable** or **called** workflow. You can leave this file here or copy it anywhere.
- `gobot-go.yml`: This is the **calling** or **caller** workflow. This is the file you would use in your project's `.github/workflows` directory to call the reusable `gobot.yml` workflow.
```yaml
name: Gobot
on:
workflow_dispatch:
inputs:
godot-version:
description: Godot Version
default: '4.3'
environment:
description: Pages Environment
type: environment
delete-old-pages:
description: Delete Old Pages
type: boolean
permissions:
pages: write
id-token: write
deployments: write
jobs:
Gobot:
uses: rakkarage/auto/.github/workflows/gobot.yml@main
with:
godot-version: ${{ github.event.inputs.godot-version }}
environment: ${{ github.event.inputs.environment }}
delete-old-pages: ${{ github.event.inputs.delete-old-pages }}
```
## Screenshots
## Todo
- gen win icon with `rcedit`?
- cache project import files in .godot folder?