+ko_fi: bendn

+name: Bug Report

+description: File a bug report

+labels: ["bug"]

+assignees:

+ - bendn

+body:

+ - type: markdown

+ attributes:

+ value: Thanks for taking the time to fill out this bug report!

+ - type: textarea

+ attributes:

+ label: What happened?

+ value: "A bug happened!"

+ placeholder: The sky fell!

+ description: Also, what did you expect to happen?

+ validations:

+ required: true

+ - type: textarea

+ attributes:

+ render: YAML

+ label: Workflow

+ description: The workflow your using. Please upload the entire workflow, not just a snippet, or "this workflow from here".

+ validations:

+ required: true

+ - type: textarea

+ attributes:

+ label: Logs

+ description: The logs generated from the workflow, preferably a link to the run.

+ validations:

+ required: true

+ - type: textarea

+ attributes:

+ label: Version

+ description: The version that you are using. Use a hash or a branch name.

+ placeholder: main

+ value: main

+ validations:

+ required: true

+name: Feature Request

+description: Request a new feature

+labels: ["enhancement"]

+assignees:

+ - bendn

+body:

+ - type: markdown

+ attributes:

+ value: Thanks for taking the time to request a new feature!

+ - type: textarea

+ attributes:

+ label: What would you like to see changed/added?

+ description: Give some examples to make it clear!

+ placeholder: Cool thing!

+ value: "A rocketship that goes to the moon when you press `a`"

+ validations:

+ required: true

+ - name: Setup

+ - name: Download android sdks

+ # Generate android keystore and settings

+ export PATH="${ANDROID_HOME}/cmdline-tools/cmdline-tools/bin:${PATH}"

+ if [[ ! -d ${ANDROID_HOME}/cmdline-tools ]]; then

+ echo "::group::Download Android SDKs"

+ mkdir -p ${ANDROID_HOME}/cmdline-tools

+ keytool -keyalg RSA -genkeypair -alias androiddebugkey -keypass android -keystore /root/debug.keystore -storepass android -dname "CN=Android Debug,O=Android,C=US" -validity 9999

+ wget -q https://dl.google.com/android/repository/commandlinetools-linux-9123335_latest.zip -O ~/tools.zip

+ unzip -q ~/tools.zip -d ${ANDROID_HOME}/cmdline-tools && rm ~/tools.zip && echo "Installed command line tools"

+ yes | sdkmanager --licenses >/dev/null && echo "Accepted licenses"

+ sdkmanager "platform-tools" "build-tools;30.0.3" "platforms;android-29" "cmdline-tools;latest" "cmake;3.10.2.4988404" "ndk;21.4.7075529" >/dev/null && echo "Installed Android SDKs"

+ echo "::endgroup::"

+ fi

+ - name: Prep build

+ if: inputs.android-keystore-base64

+ echo "::group::Prep build"

+ cd "$PROJECT_PATH"

+ password="${{ inputs.android-password }}"

+ echo "${{ inputs.android-keystore-base64 }}" | base64 --decode > ~/release.keystore && echo "Decoded keystore"

+ alias="$(keytool -storepass "$password" -list -v -keystore ~/release.keystore | grep -E '^Alias name:\s*(.+)$' | cut -d ' ' -f 3-)" && echo "Got alias name"

+ sed "s@keystore/release=\"\"@keystore/release=\"$HOME/release.keystore\"@g" -i export_presets.cfg && sed 's@keystore/release_user=".*"@keystore/release_user="'$alias'"@g' -i export_presets.cfg && sed 's@keystore/release_password=".*"@keystore/release_password="'$password'"@g' -i export_presets.cfg && echo "Configured export_presets.cfg"

+ echo "::endgroup::"

+ - name: Build

+ uses: bend-n/godot-actions/.github/actions/export@main

+ debug: ${{ inputs.android-keystore-base64 }}

+ extension: apk

+ platform: android

+ uses: bend-n/godot-actions/.github/actions/export@main

+ extension: x86_64

+ platform: linux

+ uses: bend-n/godot-actions/.github/actions/export@main

+ extension: app

+ platform: mac

+ github-pages:

+ description: To gh pages, or not to gh pages, that is the question.

+ required: true

+ default: "true"

+ uses: bend-n/godot-actions/.github/actions/export@main

+ name: index

+ extension: html

+ platform: web

+

+ - name: Test git repo

+ id: is-repo

+ run: echo "is-repo=$(git rev-parse --is-inside-work-tree || echo false)" >> "$GITHUB_OUTPUT"

+ shell: bash

+ if: steps.is-repo.outputs.is-repo == 'true' && inputs.github-pages == 'true'

+ uses: JamesIves/github-pages-deploy-action@v4

+ silent: true

+ - name: Build

+ uses: bend-n/godot-actions/.github/actions/export@main

+ extension: exe

+ platform: windows

+name: Export

+description: exports

+

+inputs:

+ platform:

+ description: The platform (web, linux, mac, android)

+ required: true

+ extension:

+ description: File extension (x86_64, exe, etc)

+ required: true

+ debug:

+ description: Debug build or no (empty string = debug)

+ required: false

+ default: "false"

+ name:

+ description: The name ($name.exe) # defaults to $NAME

+ required: false

+

+runs:

+ using: composite

+ steps:

+ - name: Setup

+ uses: bend-n/godot-actions/.github/actions/setup-godot@main

+

+ - name: Get export name

+ id: n

+ uses: bend-n/godot-actions/.github/actions/get-export-name@main

+ with:

+ platform: ${{ inputs.platform }}

+

+ - name: Build

+ run: |

+ if [[ -f .github/pre_export ]]; then

+ echo "::group::Run pre export script"

+ chmod +x .github/pre_export

+ ./.github/pre_export ${{ inputs.platform }}

+ echo "::endgroup::"

+ fi

+ cd "$PROJECT_PATH"

+ p="${{ inputs.platform }}"

+ echo "::group::${p^} Build"

+ export="--export"

+ [[ ${GODOT_VERSION:0:1} -gt 3 ]] && export="--export-release"

+ [[ -z $debug ]] && export="--export-debug"

+ mkdir -vp build/${{ inputs.platform }}

+ n="${{ env.NAME }}"

+ [[ -n "${{ inputs.name }}" ]] && n="${{ inputs.name }}"

+ timeout 30m godot -v --headless "$export" "${{ steps.n.outputs.export-name }}" "./build/${{ inputs.platform }}/$n.${{ inputs.extension }}"

+ echo "::endgroup::"

+

+ if [[ -f .github/post_export ]]; then

+ echo "::group::Run post export script"

+ chmod +x .github/post_export

+ ./.github/post_export ${{ inputs.platform }}

+ echo "::endgroup::"

+ fi

+ shell: bash

+

+ - uses: actions/upload-artifact@v4

+ with:

+ name: ${{ inputs.platform }}

+ path: ${{ env.PROJECT_PATH }}/build/${{ inputs.platform }}

+ if-no-files-found: error

+name: "Get the export name for a platform"

+description: "Get the export name for a platform, from the export_presets.cfg"

+

+inputs:

+ platform:

+ description: "The platform to get the export name for"

+ required: true

+

+outputs:

+ export-name:

+ value: ${{ steps.get-export-name.outputs.export-name }}

+ description: "The export name for the platform"

+

+runs:

+ using: "composite"

+ steps:

+ - name: Get export name

+ id: get-export-name

+ run: |

+ cd "${{ env.PROJECT_PATH }}"

+ wget -nv 'https://raw.githubusercontent.com/bend-n/godot-actions/main/.github/actions/get-export-name/get-export-name.py' -O get-export-name.py

+ python get-export-name.py "${GODOT_VERSION:0:1}" "${{ inputs.platform }}" >/dev/null || (

+ echo "::error file=${PROJECT_PATH}/export_presets.cfg,title=Missing Configuration::No export for ${{ inputs.platform }}."

+ exit 1

+ )

+ echo "export-name=$(python get-export-name.py "${GODOT_VERSION:0:1}" "${{ inputs.platform }}")" >> "$GITHUB_OUTPUT"

+ shell: bash

+#!/usr/bin/env python3

+

+import re

+import sys

+

+map = {

+ 3: {

+ "android": "Android",

+ "linux": "Linux/X11",

+ "mac": "Mac OSX",

+ "web": "HTML5",

+ "windows": "Windows Desktop",

+ },

+ 4: {

+ "android": "Android",

+ "linux": "Linux/X11",

+ "mac": "macOS",

+ "web": "Web",

+ "windows": "Windows Desktop",

+ }

+}

+

+platform = f'{map[int(sys.argv[1])][sys.argv[2]]}'

+

+with open('export_presets.cfg', "r") as f:

+ export_presets = f.read()

+ regex = r'\[preset.[0-9]+\]\n+name="(.+)"\n+platform="%s"' % platform

+ matches = re.search(

+ regex, export_presets)

+ if matches:

+ print(matches.groups()[0])

+ else:

+ sys.exit(1)

+ [[ ! -d $channel ]] && return 0

+ echo "::group::Push $channel"

+ chmod +x "$channel/"*;

+ butler push "$channel" "${{ inputs.itch-path }}:$channel"

+ echo "::endgroup::"

+ push "web"; push "linux"; push "windows";

+ [[ -d mac ]] && echo -e '#!/bin/bash\ncd "$(dirname "$0")";\nxattr -cr "$(pwd)/${{ env.NAME }}.app";\nopen -n -a "$(pwd)/${{ env.NAME }}.app"' >./mac/run.sh \

+ && push "mac"

+ - name: Check if setup needed

+ id: setup

+ run: |

+ if [[ ! -d ~/.config/godot ]];

+ then echo "needed=true" >> "$GITHUB_OUTPUT"; echo "::debug::need get deps";

+ else

+ echo "needed=false" >> "$GITHUB_OUTPUT"; echo "::debug::no need get deps";

+ fi

+ shell: bash

+

+ if: steps.setup.outputs.needed == 'true'

+ uses: actions/checkout@v3

+ fetch-depth: 0

+ path: repo

+

+ - name: Setup python

+ if: steps.setup.outputs.needed == 'true'

+ uses: actions/setup-python@v6

+ with:

+ python-version: "3.9"

+

+ - name: Setup godot

+ if: steps.setup.outputs.needed == 'true'

+ echo "::group::Setup godot"

+

+ # config

+ mkdir -p ~/.config/godot/

+ mv /root/.config/godot/editor_settings-3.tres ~/.config/godot/editor_settings-3.tres

+ mv /root/.config/godot/editor_settings-4.tres ~/.config/godot/editor_settings-4.tres || true

+ PROJECT_PATH="$(wget -q 'https://raw.githubusercontent.com/bend-n/godot-actions/main/.github/actions/setup-godot/project_path.py' -O - | python - "$PROJECT_PATH")"

+ echo "PROJECT_PATH=$PROJECT_PATH" >>$GITHUB_ENV

+ cd "$PROJECT_PATH" || true

+

+ # create version label thing

+ git config --global --add safe.directory "$(pwd)" && printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)" >version

+

+ # templates

+ TEMPS_DIRNAME="templates"

+ [[ ${GODOT_VERSION:0:1} -gt 3 ]] && TEMPS_DIRNAME="export_templates"

+ VERSION="$(wget -q 'https://raw.githubusercontent.com/bend-n/godot-actions/main/.github/actions/setup-godot/parse.py' -O - | python - "$GODOT_VERSION")"

+ TEMPLATES_PATH=".local/share/godot/$TEMPS_DIRNAME/$VERSION"

+ echo "Putting export templates in $TEMPLATES_PATH."

+ mkdir -p "$HOME/$TEMPLATES_PATH"

+ if [[ -f /root/templates.tpz ]]; then # brand new container

+ mkdir -p ~/.cache

+ unzip -q /root/templates.tpz -d "$HOME/$TEMPLATES_PATH"

+ else # fallback to the old container method

+ mv "/root/$TEMPLATES_PATH/"* "$HOME/$TEMPLATES_PATH"

+ fi

+ echo -e "Installed templates: $(ls "$HOME/$TEMPLATES_PATH" | tr '\n' ' ')\n"

+

+ # gpm

+ if [[ -f godot.package ]]; then

+ echo "Installing addons via the GPM"

+ wget -q "https://github.com/godot-package-manager/cli/releases/latest/download/godot-package-manager.x86_64" -O gpm

+ chmod +x gpm

+ ./gpm update --cfg-file godot.package --lock-file /dev/null

+ rm gpm

+ fi

+ echo "::endgroup::"

+#!/usr/bin/env python3

+

+from sys import argv

+

+parsed = argv[1].split(".")

+release = "stable"

+if len(parsed[-1]) > 1:

+ release = parsed.pop(-1)

+print(f"{'.'.join(parsed)}.{release}")

+from os import path

+from sys import argv

+

+print(path.normpath((path.join("repo", argv[1]) if argv[1] else "repo")))

+name: "export"

+on:

+ workflow_call:

+ inputs:

+ godot-version:

+ description: the godot version (deprecated, this is now parsed out of the image input)

+ required: false

+ type: string

+ # deprecationMessage: This is parsed out of the image input.

+ # deprecation message doesnt work, done manually.

+ image:

+ description: the container to use

+ default: ghcr.io/bend-n/godot-2d:3.5

+ required: true

+ type: string

+ export-name:

+ description: the name of the exec. ($export-name.exe)

+ default: ${{ github.event.repository.name }}

+ required: false

+ type: string

+ platforms:

+ description: space seperated platform list

+ default: "windows linux web android mac"

+ required: false

+ type: string

+ project-root-path:

+ description: the directory that project.godot is in (relative to repo root)

+ default: "."

+ required: false

+ type: string

+ github-pages:

+ description: to deploy to github pages or not to deploy to github pages

+ default: "true"

+ required: false

+ type: string # shut

+ itch-path:

+ description: "the itch.io path to export to, eg: bendn/chess"

+ default: "${{ github.repository_owner }}/${{ github.event.repository.name }}"

+ required: false

+ type: string

+ secrets:

+ android-keystore-base64:

+ description: For signing the apk, will be filled with andrid debug keystore if left blank

+ required: false

+ android-keystore-password:

+ description: For signing the apk, will be filled with andrid debug keystore if left blank

+ required: false

+ butler-api-key:

+ description: For deploying to itch.io

+ required: false

+

+env:

+ PROJECT_PATH: ${{ inputs.project-root-path }}

+ NAME: ${{ inputs.export-name }}

+

+jobs:

+ deprecation-warn:

+ runs-on: ubuntu-latest

+ if: ${{ inputs.godot-version }}

+ name: Warn for deprecation

+ steps:

+ - name: version deprecation warn

+ if: ${{ inputs.godot-version }}

+ run: echo "::warning title=input.godot-version deprecated::Version now parsed out of input.image"

+

+ linux:

+ runs-on: ubuntu-latest

+ if: contains(inputs.platforms, 'linux')

+ container:

+ image: ${{ inputs.image }}

+ name: Linux

+ steps:

+ - name: Get ver

+ run: echo "GODOT_VERSION=$(echo ${{ inputs.image }} | cut -d':' -f2-)" >> $GITHUB_ENV

+

+ - name: Build

+ uses: bend-n/godot-actions/.github/actions/export-linux@main

+

+ windows:

+ runs-on: ubuntu-latest

+ if: contains(inputs.platforms, 'windows')

+ container:

+ image: ${{ inputs.image }}

+ name: Windows

+ steps:

+ - name: Get ver

+ run: echo "GODOT_VERSION=$(echo ${{ inputs.image }} | cut -d':' -f2-)" >> $GITHUB_ENV

+

+ - name: Build

+ uses: bend-n/godot-actions/.github/actions/export-windows@main

+

+ mac:

+ runs-on: ubuntu-latest

+ if: contains(inputs.platforms, 'mac')

+ container:

+ image: ${{ inputs.image }}

+ name: macOS

+ steps:

+ - name: Get ver

+ run: echo "GODOT_VERSION=$(echo ${{ inputs.image }} | cut -d':' -f2-)" >> $GITHUB_ENV

+

+ - name: Build

+ uses: bend-n/godot-actions/.github/actions/export-mac@main

+

+ web:

+ runs-on: ubuntu-latest

+ if: contains(inputs.platforms, 'web')

+ container:

+ image: ${{ inputs.image }}

+ name: HTML5

+ steps:

+ - name: Get ver

+ run: echo "GODOT_VERSION=$(echo ${{ inputs.image }} | cut -d':' -f2-)" >> $GITHUB_ENV

+

+ - name: Build

+ uses: bend-n/godot-actions/.github/actions/export-web@main

+ with:

+ github-pages: ${{ inputs.github-pages }}

+

+ android:

+ runs-on: ubuntu-latest

+ if: contains(inputs.platforms, 'android')

+ container:

+ image: ${{ inputs.image }}

+ name: Android

+ steps:

+ - name: Get ver

+ run: echo "GODOT_VERSION=$(echo ${{ inputs.image }} | cut -d':' -f2-)" >> $GITHUB_ENV

+

+ - name: Build

+ uses: bend-n/godot-actions/.github/actions/export-android@main

+ with:

+ android-keystore-base64: ${{ secrets.android-keystore-base64 }}

+ android-password: ${{ secrets.android-keystore-password }}

+

+ push-itch:

+ needs: [linux, android, windows, mac, web]

+ if: always() # run even if the previous jobs were skipped

+ name: Push to itch.io

+ runs-on: ubuntu-20.04

+ steps:

+ - name: check

+ id: secret

+ run: |

+ function output() { echo "secret=$1" >> "$GITHUB_OUTPUT"; }

+ if [[ -n "${{ secrets.butler-api-key }}" ]];

+ then output "true";

+ else output "false";

+ fi

+

+ - name: Push

+ if: steps.secret.outputs.secret == 'true'

+ uses: bend-n/godot-actions/.github/actions/itch-push@main

+ with:

+ api-key: ${{ secrets.butler-api-key }}

+ itch-path: ${{ inputs.itch-path }}

+MIT License

+

+Copyright (c) 2022 bendn

+

+Permission is hereby granted, free of charge, to any person obtaining a copy

+of this software and associated documentation files (the "Software"), to deal

+in the Software without restriction, including without limitation the rights

+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

+copies of the Software, and to permit persons to whom the Software is

+furnished to do so, subject to the following conditions:

+

+The above copyright notice and this permission notice shall be included in all

+copies or substantial portions of the Software.

+

+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

+SOFTWARE.

+# godot-actions

+

+[](https://github.com/bend-n/godot-actions/blob/main/LICENSE "License")

+[](https://godotengine.org)

+<a href='https://ko-fi.com/bendn' title='Buy me a coffee' target='_blank'><img height='28' src='https://storage.ko-fi.com/cdn/brandasset/kofi_button_red.png' alt='Buy me a coffee'> </a>

+

+Github Actions composite action repository.

+

+## How to use

+

+<details open>

+<summary>Snippet</summary>

+

+```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 }}

+```

+

+</details>

+

+<details>

+<summary>Full example</summary>

+

+> **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 template

+

+jobs: # 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

+```

+

+</details>

+

+### Configuration

+

+> **Note** If script is not compiled, it must contain a [shebang](<https://en.wikipedia.org/wiki/Shebang_(Unix)>)

+

+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.