Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bend-n/godot-actions
tools for exporting godot projects via Github Actions
https://github.com/bend-n/godot-actions
ci github-actions godot
Last synced: 2 months ago
JSON representation
tools for exporting godot projects via Github Actions
- Host: GitHub
- URL: https://github.com/bend-n/godot-actions
- Owner: bend-n
- License: mit
- Created: 2022-07-12T01:38:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-15T05:58:54.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T06:20:03.636Z (6 months ago)
- Topics: ci, github-actions, godot
- Homepage:
- Size: 79.1 KB
- Stars: 25
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-godot - godot-actions - Composite actions for exporting, setting up, and pushing Godot projects to itch.io through Github Actions. (Other / 3D)
- awesome-godot-3 - godot-actions - Composite actions for exporting, setting up, and pushing Godot projects to itch.io through Github Actions. (Other / 3D)
- awesome-godot-3 - godot-actions - Composite actions for exporting, setting up, and pushing Godot projects to itch.io through Github Actions. (Other / 3D)
README
# godot-actions
[![license](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](https://github.com/bend-n/godot-actions/blob/main/LICENSE "License")
[![version](https://img.shields.io/badge/>3.5-blue?logo=godot-engine&logoColor=white&label=godot&style=for-the-badge)](https://godotengine.org)
Github Actions composite action repository.
## How to use
Snippet
```yaml
build-windows:
runs-on: ubuntu-latest
container:
image: ghcr.io/bend-n/godot-2d:3.5
name: Build windows
steps:
- name: Build
uses: bend-n/godot-actions/.github/actions/export-windows@main
env:
NAME: ${{ github.event.repository.name }}
```Full example
> **Note**
> This is a copy of [godot-template/.github/workflows/export.yml](https://github.com/bend-n/godot-template/blob/9c9e2b02ddf9f88bff872dcd2695363d09485bc4/.github/workflows/export.yml)```yaml
name: "export" # name of the workflow
on: # when it is triggered
workflow_dispatch: # manually or
push: # on a push
branches:
- main # to this branch
paths: # with modifications to these files
- "**.gd" # all gdscript files
- "**.tscn" # scene files
- "**.import" # this means a png changed
- "**.tres" # godot resources
- "**.ttf" # fonts in godot3 dont have their own .import
- ".github/workflows/export.yml" # this workflow
- "export_presets.cfg" # the export templatejobs: # the things to do
export: # a thing to do
uses: bend-n/godot-actions/.github/workflows/callable-export.yml@main
with: # variables
image: ghcr.io/bend-n/godot-2d:3.5 # the container to use
export-name: ${{ github.event.repository.name }} # the name of the exec. ($export-name.exe)
platforms: "windows linux web android mac" # space seperated list of platforms to build
project-root-path: "." # the directory that project.godot is in
github-pages: "true" # to deploy to github pages or not (anything besides 'true' == false)
itch-path: "${{ github.repository_owner }}/${{ github.event.repository.name }}" # required for itch.io deployment.
secrets: # secrets
butler-api-key: ${{ secrets.BUTLER_CREDENTIALS }} # required for itch.io deployment
android-keystore-base64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }} # for signing the apk, not required
android-keystore-password: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }} # ditto
```### Configuration
> **Note** If script is not compiled, it must contain a [shebang]()
Create a file `./.github/post_export` that will be run after installation. The executable will be run with a argument, containing the platform. (eg: `./.github/post_export linux`)
Bash example:
```bash
#!/bin/bash
[[ $1 == "web" ]] && wget -nv "example.org" -O build/web/example.html
```A `pre_export` file is also supported.