Add Working Build and Test Workflow (Mac/PC/Linux) (#1029)

* feat: enhance build workflow with caching and Boost setup for Linux, macOS, and Windows
* feat: add ccache setup for improved build performance on all platforms
* Add dependency caching and ccache support to build workflow
* feat: add Copilot instructions and improve Boost setup in build workflow
* Fix duplicate step IDs in build workflow and add copilot instructions
* Add unique step IDs for Boost setup on each platform
* Fix Windows Boost installation by switching to windows-2019
- Changed from windows-latest to windows-2019 to avoid 7-Zip 25.01 symlink security restrictions
- Updated platform_version from 2022 to 2019 for Boost installation
- 7-Zip 25.01 blocks symlinks needed for Boost header structure with 'dangerous link path' errors

Author: mfisher31

.github/copilot-instructions.md

@@ -0,0 +1,14 @@
+# Copilot Instructions for Element
+
+## General Conventions
+
+- **Always check documentation**: Before making assumptions about APIs, libraries, or tools, consult the official documentation first.
+- **Do not make assumptions and guesses**: When uncertain about implementation details, research or ask rather than guessing.
+- **KISS (Keep It Simple, Stupid)**: Favor simple, straightforward solutions over complex ones.
+- **DRY (Don't Repeat Yourself)**: Avoid code duplication. Extract common functionality into reusable functions or components.
+
+## Code Quality
+
+- Write clear, readable code with descriptive names for variables, functions, and classes.
+- Maintain consistency with the existing codebase style and patterns.
+- Consider maintainability and future developers who will read the code.

.github/workflows/build.yml

@@ -11,7 +11,7 @@ jobs:
   build-and-test:
     strategy:
       matrix:
-        os: [ubuntu-22.04, macos-latest, windows-latest]
+        os: [ubuntu-22.04, macos-latest, windows-2019]
       fail-fast: false
 
     runs-on: ${{ matrix.os }}
@@ -22,6 +22,15 @@ jobs:
       with:
         submodules: recursive
 
+    - name: Cache apt packages (Linux)
+      if: runner.os == 'Linux'
+      uses: actions/cache@v4
+      with:
+        path: /var/cache/apt/archives
+        key: ${{ runner.os }}-apt-${{ hashFiles('.github/workflows/build.yml') }}
+        restore-keys: |
+          ${{ runner.os }}-apt-
+    
     - name: Install dependencies (Linux)
       if: runner.os == 'Linux'
       run: |
@@ -47,27 +56,86 @@ jobs:
           libglu1-mesa-dev \
           mesa-common-dev
     
+    - name: Setup Boost (Linux)
+      if: runner.os == 'Linux'
+      id: install-boost-linux
+      uses: MarkusJx/[email protected]
+      with:
+        boost_version: 1.83.0
+        platform_version: 22.04
+        toolset: gcc
+    
+    - name: Cache Homebrew (macOS)
+      if: runner.os == 'macOS'
+      uses: actions/cache@v4
+      with:
+        path: |
+          ~/Library/Caches/Homebrew
+          /usr/local/Cellar
+        key: ${{ runner.os }}-brew-${{ hashFiles('.github/workflows/build.yml') }}
+        restore-keys: |
+          ${{ runner.os }}-brew-
+    
     - name: Install dependencies (macOS)
       if: runner.os == 'macOS'
       run: |
-        brew install cmake ninja pandoc boost
+        brew install cmake ninja pandoc
+    
+    - name: Setup Boost (macOS)
+      if: runner.os == 'macOS'
+      id: install-boost-macos
+      uses: MarkusJx/[email protected]
+      with:
+        boost_version: 1.83.0
+        platform_version: 11
+        toolset: clang
+
+    - name: Cache Chocolatey (Windows)
+      if: runner.os == 'Windows'
+      uses: actions/cache@v4
+      with:
+        path: ~\AppData\Local\Temp\chocolatey
+        key: ${{ runner.os }}-choco-${{ hashFiles('.github/workflows/build.yml') }}
+        restore-keys: |
+          ${{ runner.os }}-choco-
 
     - name: Install dependencies (Windows)
       if: runner.os == 'Windows'
       run: |
-        choco install cmake ninja pandoc boost -y
+        choco install cmake ninja pandoc -y
+    
+    - name: Setup Boost (Windows)
+      if: runner.os == 'Windows'
+      id: install-boost-windows
+      uses: MarkusJx/[email protected]
+      with:
+        boost_version: 1.83.0
+        platform_version: 2019
+        toolset: msvc
+        link: static
 
     - name: Setup MSVC environment (Windows)
       if: runner.os == 'Windows'
       uses: ilammy/msvc-dev-cmd@v1
 
+    - name: Setup ccache
+      uses: hendrikmuhs/[email protected]
+      with:
+        key: ${{ matrix.os }}-ccache-${{ github.sha }}
+        restore-keys: |
+          ${{ matrix.os }}-ccache-
+    
     - name: Configure CMake (Windows)
       if: runner.os == 'Windows'
       run: cmake -B build -G Ninja -DCMAKE_C_COMPILER=cl -DCMAKE_CXX_COMPILER=cl -DCMAKE_BUILD_TYPE=Release -DELEMENT_BUILD_PLUGINS=ON
+      env:
+        BOOST_ROOT: ${{ steps.install-boost-windows.outputs.BOOST_ROOT }}
 
     - name: Configure CMake (Unix)
       if: runner.os != 'Windows'
       run: cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DELEMENT_BUILD_PLUGINS=ON
+      env:
+        BOOST_ROOT: ${{ steps.install-boost-linux.outputs.BOOST_ROOT || steps.install-boost-macos.outputs.BOOST_ROOT }}
 
     - name: Build
       run: cmake --build build --config Release