imporove release workflow ( installing plugins is now easier than before)

.github/workflows/release.yml

@@ -11,25 +11,127 @@ permissions:
   contents: read
 
 jobs:
-  create_draft_release:
+  upload-plugin-unity-artifact:
     permissions:
       contents: write
       pull-requests: write
 
-    runs-on: windows-latest
+    runs-on: ubuntu-latest
 
     steps:
-      - name: Delete drafts
-        uses: hugo19941994/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v3
+
+      - name: Checkout submodules
+        run: git submodule update --init --recursive
+
+      - name: Set up .NET Core
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 7.0.x
 
-      - name: Create release draft
-        uses: release-drafter/release-drafter@v5
-        id: create_draft
+      - name: setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Build flatbuffers
+        run: python ExternalTools/BuildScripts/build_flatbuffers_csharp.py
+
+      - name: Setup unity
+        uses: game-ci/unity-builder@v4
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+          UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+          UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
+        with:
+          projectPath: Plugins/Unity/project
+          buildMethod: GenUnityPackage.Export
+
+      - name: Upload Artifact Unity
+        uses: actions/upload-artifact@v3
+        with:
+          name: Artifact-Unity-Plugin
+          path: Plugins/Unity/Artifact
+
+  upload-plugins-artifact:
+    permissions:
+      contents: write
+      pull-requests: write
+
+    strategy:
+      matrix:
+        runs-on: [windows-latest,  macos-latest, ubuntu-latest, ]
+    runs-on: ${{ matrix.runs-on }}
+
+    env:
+      Builder: 1
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Checkout submodules
+        run: git submodule update --init --recursive
+
+      - name: setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - run: pip install SCons
+
+      - name: Set up .NET Core
+        if: runner.os == 'Linux'
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 7.0.x
+
+      - name: Install cmake on ubuntu-latest
+        if: runner.os == 'Linux'
+        run: |
+            sudo apt update -y
+            sudo apt install -y cmake
 
+      - name: Install cmake on macos-latest
+        if: runner.os == 'macOS'
+        run: |
+            brew update
+            brew install cmake
+
+      - name: Install cmake on windows-latest
+        if: runner.os == 'Windows'
+        run: |
+            choco install cmake
+
+      - name: Add msbuild to PATH
+        if: runner.os == 'Windows'
+        uses: microsoft/[email protected]
+
+      - name: Build flatbuffers
+        run: python ExternalTools/BuildScripts/build_flatbuffers.py
+
+      - name: Build Godot
+        run: python ExternalTools/BuildScripts/build_godot.py
+
+      - name: Upload Artifact Godot
+        uses: actions/upload-artifact@v3
+        with:
+          name: Artifact-Godot-Plugin
+          path: Plugins/Godot/project/addons
+
+      - name: Upload Artifact UnrealEngine
+        uses: actions/upload-artifact@v3
+        with:
+          name: Artifact-UnrealEngine-Plugin
+          path: Plugins/UnrealEngine
+
+  upload-app-artifact:
+    permissions:
+      contents: write
+      pull-requests: write
+
+    runs-on: windows-latest
+
+    steps:
       - name: Checkout repository
         uses: actions/checkout@v2
 
@@ -41,18 +143,48 @@ jobs:
       - name: Build C# application
         run: dotnet build Application/BocchiTracker.WPF.sln -c Release
 
-      - name: Archive application
-        run: Compress-Archive -Path "Application/WPF/Artifact/Release/net7.0-windows" -DestinationPath "BocchiTracker.zip"
+      - name: Upload Artifact Application
+        uses: actions/upload-artifact@v3
+        with:
+          name: Artifact-BocchiTracker
+          path: Application/WPF/Artifact/Release/net7.0-windows
 
-      - name: Archive UnrealEngine plugin
-        run: Compress-Archive -Path "Plugins/UnrealEngine" -DestinationPath "UnrealEngine.zip"
+  create_draft_release:
+    needs: [upload-app-artifact, upload-plugins-artifact, upload-plugin-unity-artifact]
+    permissions:
+      contents: write
+      pull-requests: write
 
-      - name: Archive Unity plugin
-        run: Compress-Archive -Path "Plugins/Unity" -DestinationPath "Unity.zip"
+    runs-on: ubuntu-latest
 
+    steps:
+      - name: Download All Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: Artifacts
+          pattern: Artifact-*
+          merge-multiple: true
+
+      - name: Delete drafts
+        uses: hugo19941994/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create release draft
+        uses: release-drafter/release-drafter@v5
+        id: create_draft
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Archive Application
+        run: zip -r BocchiTracker.zip ./Artifacts/Artifact-BocchiTracker
+
+      - name: Archive UnrealEngine plugin
+        run: zip -r UnrealEngine.zip ./Artifacts/Artifact-UnrealEngine-Plugin
+
       - name: Archive Godot plugin
-        run: Compress-Archive -Path "Plugins/Godot" -DestinationPath "Godot.zip"
-
+        run: zip -r Godot.zip ./Artifacts/Artifact-Godot-Plugin
+  
       - name: Upload Application 
         uses: actions/upload-release-asset@v1
         env:
@@ -61,7 +193,7 @@ jobs:
           upload_url: ${{ steps.create_draft.outputs.upload_url }} 
           asset_path: ./BocchiTracker.zip
           asset_name: BocchiTracker.zip
-          asset_content_type: application/zip
+          asset_content_type: application/zip 
 
       - name: Upload UnrealEngine plugin 
         uses: actions/upload-release-asset@v1
@@ -73,22 +205,22 @@ jobs:
           asset_name: UnrealEngine.zip
           asset_content_type: application/zip
 
-      - name: Upload Unity plugin
+      - name: Upload Godot plugin
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_draft.outputs.upload_url }} 
-          asset_path: ./Unity.zip
-          asset_name: Unity.zip
+          asset_path: ./Godot.zip
+          asset_name: Godot.zip
           asset_content_type: application/zip
 
-      - name: Upload Godot plugin
+      - name: Upload Unity plugin
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_draft.outputs.upload_url }} 
-          asset_path: ./Godot.zip
-          asset_name: Godot.zip
+          asset_path: ./Artifacts/Artifact-Unity-Plugin/BocchiTracker.unitypackage
+          asset_name: BocchiTracker.unitypackage
           asset_content_type: application/zip

.gitignore

@@ -8,13 +8,40 @@ Artifact/
 *.obj
 *.yaml
 *.dblite
+*.unityproj
 launchSettings.json
 
 Plugins/UnrealEngine/BocchiTracker/Content
 Plugins/UnrealEngine/BocchiTracker/Binaries
 Plugins/UnrealEngine/BocchiTracker/Intermediate
 Plugins/UnrealEngine/ThirdParty/flatbuffers/include
 Plugins/UnrealEngine/ThirdParty/flatbuffers/lib
-UnityEditor.dll
-UnityEngine.dll
-Google.FlatBuffers.*
+Google.FlatBuffers.*
+
+### Unity ###
+# This .gitignore file should be placed at the root of your Unity project directory
+#
+# Get latest from https://github.com/github/gitignore/blob/master/Unity.gitignore
+Plugins/Unity/project/[Ll]ibrary/
+Plugins/Unity/project/[Tt]emp/
+Plugins/Unity/project/[Oo]bj/
+Plugins/Unity/project/[Bb]uild/
+Plugins/Unity/project/[Bb]uilds/
+Plugins/Unity/project/[Ll]ogs/
+Plugins/Unity/project/[Uu]ser[Ss]ettings/
+Plugins/Unity/project/*sln
+Plugins/Unity/project/*csproj
+
+
+*.pidb.meta
+*.pdb.meta
+
+sysinfo.txt
+
+# Builds
+*.apk
+*.unitypackage
+
+# Autogenerated files
+InitTestScene*.unity.meta
+InitTestScene*.unity

ExternalTools/BuildScripts/build_flatbuffers_cpp.py

@@ -16,27 +16,25 @@ def Build():
     unreal_engine_include_path = config.cUnrealEnginePath / "ThirdParty" / "flatbuffers" / "include"
     shutil.copytree(include_path, unreal_engine_include_path.resolve(), dirs_exist_ok=True)
 
-    release_lib_path = config.cFlatBuffersPath / "Release"
     if platform.system() == "Windows":
+        release_lib_path = config.cFlatBuffersPath / "Release" / "flatbuffers.lib"
         unreal_engine_lib_path = config.cUnrealEnginePath / "ThirdParty" / "flatbuffers" / "lib" / "Win64" / "Release"
     else:
+        release_lib_path = config.cFlatBuffersPath / "libflatbuffers.a"
         unreal_engine_lib_path = config.cUnrealEnginePath / "ThirdParty" / "flatbuffers" / "lib" / "Unix" / "Release"
-    shutil.copytree(release_lib_path.resolve(), unreal_engine_lib_path.resolve(), dirs_exist_ok=True)
 
-def RunMsBuild():
-    msbuild_path = Path("C:\\") / "Program Files" / "Microsoft Visual Studio" / "2022" / "Community" / "Msbuild" / "Current" / "Bin" / "MSBuild.exe"
-    if not msbuild_path.exists():
-        print("not exist MSBuild.exe, should install VisualStudio build tools.")
-        return
+    unreal_engine_lib_path.resolve().mkdir(exist_ok=True, parents=True)
+    shutil.copy(release_lib_path.resolve(), unreal_engine_lib_path.resolve())
 
+def RunMsBuild():
     subprocess.call(["cmake", "-G", "Visual Studio 17", "-DCMAKE_BUILD_TYPE=Release"], cwd=config.cFlatBuffersPath)
-    subprocess.call([msbuild_path, config.cFlatBuffersPath / "FlatBuffers.sln", "-t:flatbuffers", "/p:Configuration=Release"])
-    subprocess.call([msbuild_path, config.cFlatBuffersPath / "FlatBuffers.sln", "-t:flatc", "/p:Configuration=Release"])
+    subprocess.call(["msbuild", "FlatBuffers.sln", "-t:flatbuffers", "/p:Configuration=Release"], cwd=config.cFlatBuffersPath)
+    subprocess.call(["msbuild", "FlatBuffers.sln", "-t:flatc", "/p:Configuration=Release"], cwd=config.cFlatBuffersPath)
 
 def RunUnix():
-    subprocess.call(["cmake", "-G", "Unix Makefiles", "-DCMAKE_BUILD_TYPE=Release"])
-    subprocess.call(["make", "-j"])
+    subprocess.call(["cmake", "-G", "Unix Makefiles", "-DCMAKE_BUILD_TYPE=Release"], cwd=config.cFlatBuffersPath)
+    subprocess.call(["make", "-j"], cwd=config.cFlatBuffersPath)
 
 
 if __name__ == '__main__':
-    Build()
+    Build()

ExternalTools/BuildScripts/build_flatbuffers_csharp.py

@@ -4,20 +4,14 @@
 import config
 
 def Build():
-    print("Cmake C# flatbuffers")
-    subprocess.call(["cmake", "-G", "Visual Studio 17", "-DCMAKE_BUILD_TYPE=Release", "ExternalTools\\flatbuffers"])
-
     print("Build C# flatbuffers")
-    dotnet_path = "dotnet"
     flatbuffers_csproj_path = config.cFlatBuffersPath / "net" / "FlatBuffers" / "Google.FlatBuffers.csproj"
-    subprocess.call([dotnet_path, "build", flatbuffers_csproj_path.resolve(), "-c", "Release"])
+    subprocess.call(["dotnet", "build", flatbuffers_csproj_path.resolve(), "-c", "Release"], cwd=config.cFlatBuffersPath)
 
     print("Copying flatbuffers to Unity directory...")
     artifact = config.cFlatBuffersPath / "net" / "FlatBuffers" / "bin" / "Release" / "netstandard2.1"
-    unity_thirdparty_path = config.cUnityPath / "ThirdParty" / "flatbuffers"
-    unity_plugin_artifact_path = config.cUnityPath / "Artifact"
-    shutil.copytree(artifact, unity_thirdparty_path.resolve(), dirs_exist_ok=True)
-    shutil.copytree(artifact, unity_plugin_artifact_path.resolve(), dirs_exist_ok=True)
+    unity_external_packages_path = config.cUnityPath / "project" / "Assets" / "BocchiTracker" / "ExternalPackages" / "flatbuffers"
+    shutil.copytree(artifact, unity_external_packages_path.resolve(), dirs_exist_ok=True)
 
 if __name__ == '__main__':
     Build()

ExternalTools/BuildScripts/build_godot.py

@@ -0,0 +1,8 @@
+import subprocess
+import config
+
+def Build():
+    subprocess.call(["python", "-m", "SCons"], cwd=config.cGodotPath)
+
+if __name__ == '__main__':
+    Build()

ExternalTools/BuildScripts/config.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 
-cFlatBuffersPath = Path("ExternalTools") / "flatbuffers"
-cPluginsPath = "Plugins/"
-cUnrealEnginePath = Path(cPluginsPath) / "UnrealEngine"
-cUnityPath = Path(cPluginsPath) / "Unity"
+cFlatBuffersPath    = Path("ExternalTools") / "flatbuffers"
+cPluginsPath        = "Plugins/"
+cUnrealEnginePath   = Path(cPluginsPath) / "UnrealEngine"
+cUnityPath          = Path(cPluginsPath) / "Unity"
+cGodotPath          = Path(cPluginsPath) / "Godot"