Merge pull request #70 from Ivorforce/gh-action-setup-godot-cpp

GitHub Workflow: Use new setup-godot-cpp github action from godot-cpp submodule.

Author: paddy-exe

.github/actions/build/action.yml

@@ -5,9 +5,6 @@ on:
   pull_request:
   merge_group:
 
-env:
-  LIBNAME: example
-
 jobs:
   build:
     strategy:
@@ -260,12 +257,13 @@ jobs:
           #   os: ubuntu-20.04
     runs-on: ${{ matrix.os }}
     steps:
+      # Clone this repository
       - name: Checkout
         uses: actions/checkout@v4
         with:
           submodules: true
 
-# Lint
+      # Lint
       #- name: Setup clang-format
       #  shell: bash
       #  run: |
@@ -275,16 +273,27 @@ jobs:
       #  run: |
       #    clang-format src/** --dry-run --Werror
 
-# Build
-      - name: 🔗 GDExtension Debug Build
-        uses: ./.github/actions/build
+      # Setup dependencies
+      - name: Setup godot-cpp
+        uses: ./godot-cpp/.github/actions/setup-godot-cpp
         with:
           platform: ${{ matrix.platform }}
-          arch: ${{ matrix.arch }}
-          float-precision: ${{ matrix.float-precision }}
-          build-target-type: ${{ matrix.target-type }}
+          em-version: 3.1.62
+
+      # Build GDExtension (with caches)
+      - name: Cache .scons_cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ github.workspace }}/.scons-cache/
+          key: ${{ matrix.platform }}_${{ matrix.arch }}_${{ matrix.float-precision }}_${{ matrix.target-type }}_cache
+      - name: Build GDExtension Debug Build
+        shell: sh
+        env:
+          SCONS_CACHE: ${{ github.workspace }}/.scons-cache/
+        run: |
+          scons target=${{ matrix.target-type }} platform=${{ matrix.platform }} arch=${{ matrix.arch }} precision=${{ matrix.float-precision }}
 
-# Sign
+      # Sign the binary (macOS only)
       - name: Mac Sign
         # Disable sign if secrets are not set
         if: ${{ matrix.platform == 'macos' && env.APPLE_CERT_BASE64 }}
@@ -300,11 +309,14 @@ jobs:
           APPLE_DEV_TEAM_ID: ${{ secrets.APPLE_DEV_TEAM_ID }}
           APPLE_DEV_APP_ID: ${{ secrets.APPLE_DEV_APP_ID }}
 
+      # Clean up compilation files
       - name: Windows - Delete compilation files
         if: ${{ matrix.platform == 'windows' }}
         shell: pwsh
         run: |
           Remove-Item bin/* -Include *.exp,*.lib,*.pdb -Force
+
+      # Upload the build
       - name: Upload Artifact
         uses: actions/upload-artifact@v4
         with:

.github/workflows/builds.yml

@@ -1,4 +1,4 @@
 [submodule "godot-cpp"]
 	path = godot-cpp
 	url = https://github.com/godotengine/godot-cpp.git
-	branch = 4.0
+	branch = 4.3

.gitmodules

@@ -26,121 +26,8 @@ For getting started after cloning your own copy to your local machine, you shoul
 
 ## Usage - Actions
 
-The actions builds `godot-cpp` at a specified location, and then builds the `gdextension` at a configurable location. It builds for desktop, mobile and web and allows for configuration on what platforms you need. It also supports configuration for debug and release builds, and for double builds.
-
-The action uses SConstruct for both godot-cpp and the GDExtension that is built.
-
-To reuse the build actions, in a github actions yml file, do the following:
-
-```yml
-name: Build GDExtension
-on:
-  workflow_call:
-  push:
-
-jobs:
-  build:
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - platform: linux
-            arch: x86_64
-            os: ubuntu-20.04
-          - platform: windows
-            arch: x86_32
-            os: windows-latest
-          - platform: windows
-            arch: x86_64
-            os: windows-latest
-          - platform: macos
-            arch: universal
-            os: macos-latest
-          - platform: android
-            arch: arm64
-            os: ubuntu-20.04
-          - platform: android
-            arch: arm32
-            os: ubuntu-20.04
-          - platform: android
-            arch: x86_64
-            os: ubuntu-20.04
-          - platform: android
-            arch: x86_32
-            os: ubuntu-20.04
-          - platform: ios
-            arch: arm64
-            os: macos-latest
-          - platform: web
-            arch: wasm32
-            os: ubuntu-20.04
-
-    runs-on: ${{ matrix.os }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          submodules: true
-      - name: 🔗 GDExtension Build
-        uses: godotengine/godot-cpp-template/.github/actions/build@main
-        with:
-          platform: ${{ matrix.platform }}
-          arch: ${{ matrix.arch }}
-          float-precision: single
-          build-target-type: template_release
-      - name: 🔗 GDExtension Build
-        uses: ./.github/actions/build
-        with:
-          platform: ${{ matrix.platform }}
-          arch: ${{ matrix.arch }}
-          float-precision: ${{ matrix.float-precision }}
-          build-target-type: template_debug
-      - name: Mac Sign
-        if: ${{ matrix.platform == 'macos' && env.APPLE_CERT_BASE64 }}
-        env:
-          APPLE_CERT_BASE64: ${{ secrets.APPLE_CERT_BASE64 }}
-        uses: godotengine/godot-cpp-template/.github/actions/sign@main
-        with:
-          FRAMEWORK_PATH: bin/macos/macos.framework
-          APPLE_CERT_BASE64: ${{ secrets.APPLE_CERT_BASE64 }}
-          APPLE_CERT_PASSWORD: ${{ secrets.APPLE_CERT_PASSWORD }}
-          APPLE_DEV_PASSWORD: ${{ secrets.APPLE_DEV_PASSWORD }}
-          APPLE_DEV_ID: ${{ secrets.APPLE_DEV_ID }}
-          APPLE_DEV_TEAM_ID: ${{ secrets.APPLE_DEV_TEAM_ID }}
-          APPLE_DEV_APP_ID: ${{ secrets.APPLE_DEV_APP_ID }}
-      - name: Upload Artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: GDExtension-${{ matrix.platform }}-${{ matrix.arch }}
-          path: |
-            ${{ github.workspace }}/bin/**
-  merge:
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Merge Artifacts
-        uses: actions/upload-artifact/merge@v4
-        with:
-          name: GDExtension-all
-          pattern: GDExtension-*
-          delete-merged: true
-```
-
-The above example is a lengthy one, so we will go through it action by action to see what is going on.
-
-In the `Checkout` step, we checkout the code.
-In the `🔗 GDExtension Build` step, we are using the reusable action:
-```yml
-uses: godotengine/godot-cpp-template/.github/actions/build@main
-with:
-  platform: ${{ matrix.platform }}
-  arch: ${{ matrix.arch }}
-  float-precision: single
-  build-target-type: template_release
-```
-with the parameters from the matrix.
-
-As a result of this step, the binaries will be built in the `bin` folder (as specified in the SConstruct file). After all builds are completed, all individual builds will be merged into one common GDExtension-all zip that you can download.
+This repository comes with a GitHub action that builds the GDExtension for cross-platform use. It triggers automatically for each pushed change. You can find and edit it in [builds.yml](.github/workflows/builds.yml).
+After a workflow run is complete, you can find the file `godot-cpp-template.zip` on the `Actions` tab on GitHub.
 
 Note: for macos, you will have to build the binary as a `.dylib` in a `EXTENSION-NAME.framework` folder. The framework folder should also have a `Resources` folder with a file called `Info.plist`. Without this file, signing will fail.