Improved build pipeline & scripts (#620)

* Simplified `gen_proj`
* Full premake5 argument passthrough
* Build matrix (debug/config)
* Now automatically trigger release builds on version tag

Author: adriengivry

.github/workflows/linux.yml

@@ -1,4 +1,4 @@
-name: Linux Clang
+name: Linux
 
 on:
   workflow_dispatch:
@@ -12,17 +12,15 @@ env:
   # Path to the solution file relative to the root of the project.
   SOLUTION_FILE_PATH: ./
 
-  # Configuration type to build.
-  # You can convert this to a build matrix if you need coverage of multiple configuration types.
-  # https://docs.github.com/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
-  BUILD_CONFIGURATION: release
-  BUILD_PLATFORM: x64
-
 jobs:
   build:
-    name: Linux Clang Build
+    name: Clang ${{ matrix.configuration }} x64
     runs-on: ubuntu-latest
     if: github.event.pull_request.draft == false
+    
+    strategy:
+      matrix:
+        configuration: [Debug, Release]
 
     steps:
     - uses: actions/checkout@v5
@@ -32,10 +30,10 @@ jobs:
 
     - name: Generate premake5 solution
       working-directory: ${{env.SOLUTION_FILE_PATH}}
-      run: ./gen_proj_linux.sh
+      run: ./gen_proj.sh
 
     - name: Build
       working-directory: ${{env.GITHUB_WORKSPACE}}
-      # Add additional options to the MSBuild command line here (like platform or verbosity level).
-      # See https://docs.microsoft.com/visualstudio/msbuild/msbuild-command-line-reference
-      run: make -j$(nproc) config=${{env.BUILD_CONFIGURATION}}_${{env.BUILD_PLATFORM}}
+      run: |
+        CONFIG_LOWER=$(echo "${{ matrix.configuration }}" | tr '[:upper:]' '[:lower:]')
+        make -j$(nproc) config=${CONFIG_LOWER}_x64

.github/workflows/linux_release.yml

@@ -2,6 +2,9 @@ name: Linux Release
 
 on:
   workflow_dispatch:
+  push:
+    tags:
+      - 'v*'
 
 jobs:
   build:

.github/workflows/windows.yml

@@ -1,4 +1,4 @@
-name: Windows MSVC
+name: Windows
 
 on:
   workflow_dispatch:
@@ -12,29 +12,26 @@ env:
   # Path to the solution file relative to the root of the project.
   SOLUTION_FILE_PATH: .\
 
-  # Configuration type to build.
-  # You can convert this to a build matrix if you need coverage of multiple configuration types.
-  # https://docs.github.com/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
-  BUILD_CONFIGURATION: Release
-
 jobs:
   build:
-    name: Windows MSVC Build
+    name: MSVC ${{ matrix.configuration }} x64
     runs-on: windows-latest
     if: github.event.pull_request.draft == false
+    
+    strategy:
+      matrix:
+        configuration: [Debug, Release]
 
     steps:
     - uses: actions/checkout@v5
 
-    - name: Generate premake5 solution
-      working-directory: ${{env.SOLUTION_FILE_PATH}}
-      run: .\gen_proj_win32.bat
-
     - name: Add MSBuild to PATH
       uses: microsoft/setup-msbuild@v2
 
+    - name: Generate premake5 solution
+      working-directory: ${{env.SOLUTION_FILE_PATH}}
+      run: .\gen_proj.bat
+
     - name: Build
       working-directory: ${{env.GITHUB_WORKSPACE}}
-      # Add additional options to the MSBuild command line here (like platform or verbosity level).
-      # See https://docs.microsoft.com/visualstudio/msbuild/msbuild-command-line-reference
-      run: msbuild /m /p:Configuration=${{env.BUILD_CONFIGURATION}} ${{env.SOLUTION_FILE_PATH}}
+      run: msbuild /m /p:Configuration=${{ matrix.configuration }} ${{env.SOLUTION_FILE_PATH}} /p:Platform=x64

.github/workflows/windows_release.yml

@@ -2,6 +2,9 @@ name: Windows Release
 
 on:
   workflow_dispatch:
+  push:
+    tags:
+      - 'v*'
 
 jobs:
   build:

Dependencies/premake5/bin/premake5.exe

@@ -68,32 +68,25 @@ In a rush? [Get the latest release](https://github.com/Overload-Technologies/Ove
 ```powershell
 git clone https://github.com/Overload-Technologies/Overload
 cd Overload
-.\gen_proj_win32.bat # generate project files for Visual Studio 2022
-
-# (Optional) open the solution in Visual Studio
-.\Overload.sln
+.\gen_proj.bat vs2022 # generate project files for Visual Studio 2022
+.\Overload.sln # Open the solution in Visual Studio
 ```
 
+> [!note]
+> Officially supported actions for `gen_proj.bat` are: `vs2022` (default), `gmake`, `codelite`.<br/>
+> Refer to [premake's website](https://premake.github.io/docs/Using-Premake) for more information.
+
 ### Linux (Clang)
 ```bash
 git clone https://github.com/Overload-Technologies/Overload
 cd Overload
-./gen_proj_linux.sh # generate Makefiles
-
-# (Optional) build the project
-make
+./gen_proj.sh gmake # generate project files for Makefile
+make -j$(nproc) # build the project using all available CPU cores
 ```
 
-### Other Platforms & IDEs
-`gen_proj` scripts can be invoked with an argument to specify the the action to perform.
-```bash
-# Generating Makefile on Windows
-.\gen_proj_win32.bat gmake
-
-# Generating CodeLite project on Linux
-./gen_proj_linux.sh codelite
-``` 
-*Please refer to [Premake5's documentation](https://premake.github.io/docs/Using-Premake) to find supported IDEs.*
+> [!note]
+> Officially supported actions for `gen_proj.sh` are: `gmake` (default), `codelite`.<br/>
+> Refer to [premake's website](https://premake.github.io/docs/Using-Premake) for more information.
 
 # Architecture
 Overload is divided into 11 modules: 9 libraries (SDK), and 2 executables (Applications).

README.md

@@ -6,9 +6,9 @@ CONFIGURATION="${1:-debug}"
 # Convert to lowercase for make
 CONFIG_LOWER=$(echo "$CONFIGURATION" | tr '[:upper:]' '[:lower:]')
 
-# Generate the projects
+# Generate project files
 pushd "$(dirname "$0")" > /dev/null
-./GenerateProjects.sh gmake
+./GenerateProjects.sh
 popd > /dev/null
 
 # Build the solution

Scripts/Linux/BuildAll.sh Scripts/Linux/Build.shScripts/Linux/BuildAll.sh renamed to Scripts/Linux/Build.sh

@@ -1,11 +1,13 @@
 #!/bin/bash
 
-# Get the action parameter (default to gmake)
-ACTION="${1:-gmake}"
+WORKSPACE_ROOT="$(dirname "$0")/../.."
 
-SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
-PREMAKE_PATH="$SCRIPT_DIR/../../Dependencies/premake5/bin/premake5"
+# If no argument is provided, default to gmake
+if [ $# -eq 0 ]; then
+    echo "No action specified. Defaulting to 'gmake'."
+    set -- gmake
+fi
 
-pushd "$SCRIPT_DIR/../.." > /dev/null
-"$PREMAKE_PATH" "$ACTION"
+pushd "$WORKSPACE_ROOT" > /dev/null
+"./Dependencies/premake5/bin/premake5" "$@"
 popd > /dev/null

Scripts/Linux/GenerateProjects.sh

@@ -11,14 +11,14 @@ for arg in "$@"; do
 done
 
 # Build Debug
-"$SCRIPT_DIR/BuildAll.sh" debug
+"$SCRIPT_DIR/Build.sh" debug
 if [ $? -ne 0 ]; then
     echo "Debug build failed. Exiting."
     exit $?
 fi
 
 # Build Release
-"$SCRIPT_DIR/BuildAll.sh" release
+"$SCRIPT_DIR/Build.sh" release
 if [ $? -ne 0 ]; then
     echo "Release build failed. Exiting."
     exit $?

Scripts/Linux/MakeReleaseBuild.sh

@@ -6,7 +6,7 @@ set "CONFIGURATION=%~1"
 
 :: Generate the projects
 pushd "%~dp0"
-call GenerateProjects vs2022 %CONFIGURATION%
+call .\GenerateProjects.bat vs2022 %CONFIGURATION%
 popd
 
 :: Initialize variables