Modernize build and CI to match recent changes to godot_openxr_vendors (#5)

Author: dsnopek

.github/workflows/build-addon-on-push.yml

@@ -24,48 +24,46 @@ jobs:
       fail-fast: true
       matrix:
         include:
-          # Godot Meta Toolkit
-          - name: Godot Meta Toolkit Linux (x86_64)
+          - name: 🐧 Linux (x86_64)
             os: ubuntu-20.04
             platform: linux
             flags: arch=x86_64
             artifact_name: godotmetatoolkit-build-files-linux-x86_64
             artifact_path: godot_meta_toolkit/demo/addons/godot_meta_toolkit/.bin/linux/*/*/*.so
             cache-name: linux-x86_64
-          - name: Godot Meta Toolkit Windows
+          - name: 🏁 Windows (x86_64)
             os: windows-latest
             platform: windows
             artifact_name: godotmetatoolkit-build-files-windows
             artifact_path: godot_meta_toolkit/demo/addons/godot_meta_toolkit/.bin/windows/*/*/*.dll
             cache-name: windows-x86_64
-          - name: Godot Meta Toolkit MacOS
+          - name: 🍎 MacOS (universal)
             os: macos-latest
             platform: macos
             flags: arch=universal
             artifact_name: godotmetatoolkit-build-files-macos
             artifact_path: godot_meta_toolkit/demo/addons/godot_meta_toolkit/.bin/macos/*/*.framework
             cache-name: macos-universal
-          - name: Godot Meta Toolkit Android
+          - name: 🤖 Android (arm64)
             os: ubuntu-20.04
             platform: android
             flags: arch=arm64
             artifact_name: godotmetatoolkit-build-files-android
             artifact_path: |
-              godot_meta_toolkit/demo/addons/godot_meta_toolkit/.bin/android/*/*.aar
               godot_meta_toolkit/demo/addons/godot_meta_toolkit/.bin/android/*/*/*.so
             cache-name: android
 
     # Note, to satisfy the asset library we need to make sure our zip files have a root folder
     # this is why we checkout into godot_meta_toolkit and build into asset
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: godot_meta_toolkit
           submodules: recursive
           lfs: 'true'
-      - name: Setup Godot build cache
-        uses: ./godot_meta_toolkit/thirdparty/godot-cpp/.github/actions/godot-cache
+      - name: Restore Godot build cache
+        uses: ./godot_meta_toolkit/thirdparty/godot-cpp/.github/actions/godot-cache-restore
         with:
           cache-name: ${{ matrix.cache-name }}
         continue-on-error: true
@@ -74,6 +72,7 @@ jobs:
           wget "${{ env.META_PLATFORM_SDK_URL }}" -O meta_platform_sdk.zip
           cd godot_meta_toolkit/thirdparty/ovr_platform_sdk
           unzip -a ../../../meta_platform_sdk.zip
+          rm -rf Android/libs/armeabi-v7a
           cd ../../..
           rm meta_platform_sdk.zip
         if: runner.os != 'Windows'
@@ -87,71 +86,76 @@ jobs:
           Remove-Item "meta_platform_sdk.zip"
         if: runner.os == 'Windows'
       - name: Set up Python (for SCons)
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.x"
       - name: Android dependencies
         uses: nttld/setup-ndk@v1
         with:
           ndk-version: r23c
           link-to-sdk: true
+        if: matrix.platform == 'android'
       - name: Install scons
         run: |
           python -m pip install scons==4.0.0
       - name: Create extension library
         run: |
           cd godot_meta_toolkit
-          scons platform=${{ matrix.platform }} target=template_debug ${{ matrix.flags }}
-          scons platform=${{ matrix.platform }} target=template_release ${{ matrix.flags }}
+          scons platform=${{ matrix.platform }} target=template_debug ${{ matrix.flags }} build_profile=thirdparty/godot_cpp_build_profile/build_profile.json
+          scons platform=${{ matrix.platform }} target=template_release ${{ matrix.flags }} build_profile=thirdparty/godot_cpp_build_profile/build_profile.json
           cd ..
-
-      # On Android we build our loaders and build our extension with gradlew
-      - name: Setup java
-        uses: actions/setup-java@v3
+      - name: Save Godot build cache
+        uses: ./godot_meta_toolkit/thirdparty/godot-cpp/.github/actions/godot-cache-save
         with:
-          java-version: 17
-          distribution: "adopt"
-        if: matrix.platform == 'android'
-      - name: Validate Gradle wrapper
-        uses: gradle/wrapper-validation-action@v1
-        if: matrix.platform == 'android'
-      - name: Create Godot-CPP library
-        run: |
-          cd godot_meta_toolkit/thirdparty/godot-cpp
-          scons platform=${{ matrix.platform }} target=template_debug arch=arm64
-          scons platform=${{ matrix.platform }} target=template_release arch=arm64
-          scons platform=${{ matrix.platform }} target=template_debug arch=x86_64
-          scons platform=${{ matrix.platform }} target=template_release arch=x86_64
-          cd ../../..
-        if: matrix.platform == 'android'
-      - name: Create Godot Meta Toolkit AARs
-        uses: burrunan/gradle-cache-action@v1
-        with:
-          build-root-directory: godot_meta_toolkit
-          arguments: build
-        if: matrix.platform == 'android'
-
+          cache-name: ${{ matrix.cache-name }}
+        continue-on-error: true
       - name: Upload build files (artifacts)
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.artifact_name }}
+          include-hidden-files: true
           path: |
             ${{ matrix.artifact_path }}
 
-  # GODOT 4.2 ADDON GENERATION SECTION
   asset:
     name: Assembling the asset
     runs-on: ubuntu-20.04
     needs: build
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: godot_meta_toolkit
       - name: Download all workflow run artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
+      - name: Download Meta Platform SDK
+        run: |
+          wget "${{ env.META_PLATFORM_SDK_URL }}" -O meta_platform_sdk.zip
+          cd godot_meta_toolkit/thirdparty/ovr_platform_sdk
+          unzip -a ../../../meta_platform_sdk.zip
+          rm -rf Android/libs/armeabi-v7a
+          cd ../../..
+          rm meta_platform_sdk.zip
+      - name: Setup java
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: "adopt"
+      - name: Validate Gradle wrapper
+        uses: gradle/actions/wrapper-validation@v3
+      - name: Copy Android binaries
+        run: |
+          mkdir -p godot_meta_toolkit/toolkit/src/main/libs/debug/arm64-v8a/arm64-v8a
+          cp godotmetatoolkit-build-files-android/template_debug/arm64/libgodot_meta_toolkit.so godot_meta_toolkit/toolkit/src/main/libs/debug/arm64-v8a/arm64-v8a/
+
+          mkdir -p godot_meta_toolkit/toolkit/src/main/libs/release/arm64-v8a/arm64-v8a
+          cp godotmetatoolkit-build-files-android/template_release/arm64/libgodot_meta_toolkit.so godot_meta_toolkit/toolkit/src/main/libs/release/arm64-v8a/arm64-v8a/
+      - name: Create Godot Meta Toolkit AARs
+        run: |
+          cd godot_meta_toolkit
+          ./gradlew build
+          cd ..
       - name: Create Godot Meta Toolkit Addon
         run: |
           mkdir asset
@@ -172,9 +176,10 @@ jobs:
           cp -r godotmetatoolkit-build-files-macos/* asset/addons/godot_meta_toolkit/.bin/macos/
 
       - name: Create Godot Meta Toolkit addon artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: GodotMetaToolkitAddon
+          include-hidden-files: true
           path: |
             asset
       - name: Zip addon
@@ -186,6 +191,7 @@ jobs:
         with:
           allowUpdates: true
           artifacts: "godotmetatoolkitaddon.zip"
+          draft: true
           omitNameDuringUpdate: true
           omitBodyDuringUpdate: true
           omitDraftDuringUpdate: true

.github/workflows/documentation.yml

@@ -13,10 +13,10 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 

.github/workflows/static_checks.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install dependencies
         run: |

SConstruct

@@ -33,8 +33,13 @@ sources += Glob("#toolkit/src/main/cpp/platform_sdk/*.cpp")
 sources += Glob("#toolkit/gen/src/*.cpp")
 
 binary_path = '#demo/addons/godot_meta_toolkit/.bin'
+android_src_path = '#toolkit/src'
 project_name = 'godot_meta_toolkit'
 
+if env['platform'] == "android":
+    env.Append(LIBPATH=['thirdparty/ovr_platform_sdk/Android/libs/arm64-v8a'])
+    env.Append(LIBS=['ovrplatformloader'])
+
 # Create the library target
 if env["platform"] == "macos":
     library = env.SharedLibrary(
@@ -61,3 +66,24 @@ else:
 
 Default(library)
 
+if env["platform"] == "android":
+    android_target = "release" if env["target"] == "template_release" else "debug"
+    android_arch = ""
+    if env["arch"] == "arm64":
+        android_arch = "arm64-v8a"
+    elif env["arch"] == "x86_64":
+        android_arch = "x86_64"
+    else:
+        raise Exception("Unable to map %s to Android architecture name" % env["arch"])
+
+    library_copy_path = "{}/main/libs/{}/{}/{}/lib{}{}".format(
+        android_src_path,
+        android_target,
+        android_arch,
+        android_arch,
+        project_name,
+        env["SHLIBSUFFIX"])
+
+    library_copy = env.Command(library_copy_path, library, Copy('$TARGET', '$SOURCE'))
+
+    Default(library_copy)

build.gradle

@@ -65,35 +65,41 @@ task buildSconsArtifacts {
             break
         }
     }
-    if (sconsExecutableFile == null) {
-        throw new GradleException("Unable to find executable path for the '$sconsName' command.")
-    } else {
-        logger.debug("Found executable path for $sconsName: ${sconsExecutableFile.absolutePath}")
-    }
 
-    // Build the Godot-CPP bindings
-    tasks.create(name: "buildGodotCPPDebug", type: Exec) {
-        executable sconsExecutableFile.absolutePath
-        args "--directory=thirdparty/godot-cpp", "platform=android", "target=template_debug", "arch=arm64"
-    }
-    tasks.create(name: "buildGodotCPPRelease", type: Exec) {
-        executable sconsExecutableFile.absolutePath
-        args "--directory=thirdparty/godot-cpp", "platform=android", "target=template_release", "arch=arm64"
+    // Using `doFirst` so the exception doesn't happen until this task actually runs.
+    doFirst {
+        if (sconsExecutableFile == null) {
+            throw new GradleException("Unable to find executable path for the '$sconsName' command.")
+        } else {
+            logger.debug("Found executable path for $sconsName: ${sconsExecutableFile.absolutePath}")
+        }
     }
 
-    dependsOn 'buildGodotCPPDebug'
-    dependsOn 'buildGodotCPPRelease'
+    if (sconsExecutableFile != null) {
+        // Build the GDExtension library for Android.
+        tasks.create(name: "buildGodotMetaToolkitAndroidArm64Debug", type: Exec) {
+            executable sconsExecutableFile.absolutePath
+            args "--directory=.", "platform=android", "target=template_debug", "arch=arm64", "build_profile=thirdparty/godot_cpp_build_profile/build_profile.json"
+        }
+        tasks.create(name: "buildGodotMetaToolkitAndroidArm64Release", type: Exec) {
+            executable sconsExecutableFile.absolutePath
+            args "--directory=.", "platform=android", "target=template_release", "arch=arm64", "build_profile=thirdparty/godot_cpp_build_profile/build_profile.json"
+        }
 
-    // Creating gradle task to generate the editor gdextension binaries for the godot_meta_toolkit addon
-    tasks.create(name: "buildGodotMetaToolkitDebugGDExtension", type: Exec) {
-        executable sconsExecutableFile.absolutePath
-        args "--directory=.", "target=template_debug"
-    }
-    tasks.create(name: "buildGodotMetaToolkitReleaseGDExtension", type: Exec) {
-        executable sconsExecutableFile.absolutePath
-        args "--directory=.", "target=template_release"
-    }
+        dependsOn 'buildGodotMetaToolkitAndroidArm64Debug'
+        dependsOn 'buildGodotMetaToolkitAndroidArm64Release'
 
-    dependsOn 'buildGodotMetaToolkitDebugGDExtension'
-    dependsOn 'buildGodotMetaToolkitReleaseGDExtension'
+        // Build the GDExtension library for desktop.
+        tasks.create(name: "buildGodotMetaToolkitDesktopDebug", type: Exec) {
+            executable sconsExecutableFile.absolutePath
+            args "--directory=.", "target=template_debug", "build_profile=thirdparty/godot_cpp_build_profile/build_profile.json"
+        }
+        tasks.create(name: "buildGodotMetaToolkitDesktopRelease", type: Exec) {
+            executable sconsExecutableFile.absolutePath
+            args "--directory=.", "target=template_release", "build_profile=thirdparty/godot_cpp_build_profile/build_profile.json"
+        }
+
+        dependsOn 'buildGodotMetaToolkitDesktopDebug'
+        dependsOn 'buildGodotMetaToolkitDesktopRelease'
+    }
 }

config.gradle

@@ -6,7 +6,6 @@ ext {
             targetSdk               : 34,
             javaVersion             : JavaVersion.VERSION_17,
             kotlinVersion           : '1.9.20',
-            cmakeVersion            : '3.22.1',
             ndkVersion              : '23.2.8568313'
     ]
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
 #Mon Mar 25 17:51:26 PDT 2024
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionSha256Sum=38f66cd6eef217b4c35855bb11ea4e9fbc53594ccccb5fb82dfd317ef8c2c5a3
 distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

thirdparty/godot_cpp_build_profile/build_profile.json

@@ -0,0 +1,39 @@
+{
+    "enabled_classes": [
+        "AcceptDialog",
+        "BaseButton",
+        "BoxContainer",
+        "Button",
+        "CanvasItem",
+        "ConfirmationDialog",
+        "Container",
+        "Control",
+        "EditorExportPlatform",
+        "EditorExportPlatformAndroid",
+        "EditorExportPlugin",
+        "EditorFileDialog",
+        "EditorInterface",
+        "EditorPlugin",
+        "EditorSettings",
+        "Engine",
+        "FileAccess",
+        "HBoxContainer",
+        "Label",
+        "LineEdit",
+        "MainLoop",
+        "Node",
+        "OS",
+        "ProjectSettings",
+        "RefCounted",
+        "Resource",
+        "RichTextLabel",
+        "ScrollContainer",
+        "Shortcut",
+        "TextServer",
+        "Texture",
+        "Texture2D",
+        "VBoxContainer",
+        "Viewport",
+        "Window"
+    ]
+}