Desktop Audit

.github/workflows/desktop_build.yml

@@ -0,0 +1,174 @@
+name: Desktop Build
+
+on:
+  push:
+    branches: [ "desktop" ]
+  pull_request:
+    branches: [ "desktop" ]
+  workflow_dispatch: # manual trigger
+
+jobs:
+  setup:
+    runs-on: ubuntu-latest
+    outputs:
+      vortex_version_major: ${{ steps.set_version.outputs.vortex_version_major }}
+      vortex_version_minor: ${{ steps.set_version.outputs.vortex_version_minor }}
+      vortex_build_number: ${{ steps.set_version.outputs.vortex_build_number }}
+      vortex_version_number: ${{ steps.set_version.outputs.vortex_version_number }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetches all history for all branches and tags
+      - name: Determine Version and Build Number
+        id: set_version
+        run: |
+          BRANCH_SUFFIX="l"
+          # Fetch all tags
+          git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+          # Get the latest tag that matches the branch suffix
+          LATEST_TAG=$(git tag --list "*${BRANCH_SUFFIX}" | sort -V | tail -n1)
+          if [ -z "$LATEST_TAG" ]; then
+            echo "No matching tags found. Setting default version."
+            VERSION_MAJOR="0"
+            VERSION_MINOR="1"
+            BUILD_NUMBER="0"
+          else
+            echo "Found latest tag: $LATEST_TAG"
+            VERSION_NUMBER=$(echo $LATEST_TAG | sed "s/${BRANCH_SUFFIX}//g")
+            VERSION_MAJOR=$(echo $VERSION_NUMBER | cut -d. -f1)
+            VERSION_MINOR=$(echo $VERSION_NUMBER | cut -d. -f2)
+            BUILD_NUMBER=$(git rev-list --count $LATEST_TAG..HEAD)
+          fi
+          FULL_VERSION="$VERSION_MAJOR.$VERSION_MINOR.$BUILD_NUMBER"
+          echo "vortex_version_major=$VERSION_MAJOR" >> $GITHUB_OUTPUT
+          echo "vortex_version_minor=$VERSION_MINOR" >> $GITHUB_OUTPUT
+          echo "vortex_build_number=$BUILD_NUMBER" >> $GITHUB_OUTPUT
+          echo "vortex_version_number=$FULL_VERSION" >> $GITHUB_OUTPUT
+          echo "Version Number: $FULL_VERSION"
+
+  test:
+    needs: setup
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout current repository
+        uses: actions/checkout@v4
+      - name: Update Package Lists
+        run: sudo apt-get update
+      - name: Install Dependencies
+        run: sudo apt-get install valgrind g++ make --fix-missing
+      - name: Build
+        run: |
+          export VORTEX_VERSION_MAJOR=${{ needs.setup.outputs.vortex_version_major }}
+          export VORTEX_VERSION_MINOR=${{ needs.setup.outputs.vortex_version_minor }}
+          export VORTEX_BUILD_NUMBER=${{ needs.setup.outputs.vortex_build_number }}
+          export VORTEX_VERSION_NUMBER=${{ needs.setup.outputs.vortex_version_number }}
+          make -j
+        working-directory: VortexEngine
+      - name: Set execute permissions for test script
+        run: chmod +x ./runtests.sh
+        working-directory: VortexEngine/tests
+      - name: Run general tests
+        run: ./runtests.sh --general
+        working-directory: VortexEngine/tests
+      - name: Upload Vortex Binary and Library Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-artifacts
+          path: |
+            VortexEngine/VortexLib/vortex.a
+            VortexEngine/VortexCLI/vortex
+
+
+  wasm:
+    needs: [setup, test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout current repository
+        uses: actions/checkout@v4
+      - name: Update Package Lists
+        run: sudo apt-get update
+      - name: Install Emscripten
+        run: |
+          sudo apt install -y cmake python3
+          git clone https://github.com/emscripten-core/emsdk.git
+          cd emsdk
+          ./emsdk install latest
+          ./emsdk activate latest
+        working-directory: VortexEngine/VortexLib
+      - name: Build Webassembly
+        run: |
+          source ./emsdk/emsdk_env.sh
+          export VORTEX_VERSION_MAJOR=${{ needs.setup.outputs.vortex_version_major }}
+          export VORTEX_VERSION_MINOR=${{ needs.setup.outputs.vortex_version_minor }}
+          export VORTEX_BUILD_NUMBER=${{ needs.setup.outputs.vortex_build_number }}
+          export VORTEX_VERSION_NUMBER=${{ needs.setup.outputs.vortex_version_number }}
+          make -j wasm
+        working-directory: VortexEngine/VortexLib
+      - name: Upload WASM Files as Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: wasm-artifacts
+          path: |
+            VortexEngine/VortexLib/VortexLib.wasm
+            VortexEngine/VortexLib/VortexLib.js
+
+  docs:
+    needs: [setup, test, wasm]
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/desktop'
+    steps:
+      - name: Checkout current repository
+        uses: actions/checkout@v4
+      - name: Update Package Lists
+        run: sudo apt-get update
+      - name: Install Dependencies
+        run: sudo apt-get install doxygen graphviz texlive --fix-missing
+      - name: Checkout doxygen-awesome
+        run: git clone https://github.com/jothepro/doxygen-awesome-css.git doxygen-awesome-css
+      - name: Generate Documentation
+        run: |
+          mkdir -p docs/desktop
+          doxygen Doxyfile
+          echo "Listing contents of docs/desktop:"
+          ls -R docs/desktop || echo "No files found in docs/desktop"
+      - name: Upload Doxygen Documentation as Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: doxygen-docs-desktop
+          path: docs/desktop
+
+  deploy:
+    needs: [setup, test, wasm, docs]
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/desktop'
+    steps:
+      - name: Download test build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: test-artifacts
+          path: build/desktop-library
+      - name: Download wasm build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: wasm-artifacts
+          path: build/desktop-library
+      - name: Create zip archive for desktop library
+        run: |
+          cd build/desktop-library
+          zip -r VortexDesktopLibrary-${{ needs.setup.outputs.vortex_version_number }}.zip *
+          mv VortexDesktopLibrary-${{ needs.setup.outputs.vortex_version_number }}.zip ../
+      - name: Upload Desktop Library to Vortex Community
+        run: |
+          DEVICE_TYPE="desktop"
+          VERSIONED_ZIP="VortexDesktopLibrary-${DEVICE_TYPE}-${{ needs.setup.outputs.vortex_version_number }}.zip"
+          mv build/VortexDesktopLibrary-${{ needs.setup.outputs.vortex_version_number }}.zip build/$VERSIONED_ZIP
+          echo "Version is ${{ needs.setup.outputs.vortex_version_number }}"
+          echo "Filename is $VERSIONED_ZIP"
+          curl -X POST \
+            -F "file=@build/$VERSIONED_ZIP" \
+            -F "device=$DEVICE_TYPE" \
+            -F "version=${{ needs.setup.outputs.vortex_version_number }}" \
+            -F "category=library" \
+            -F "clientApiKey=${{ secrets.VORTEX_COMMUNITY_API_KEY }}" \
+            https://vortex.community/firmware/upload
+

Doxyfile

@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = docs/core
+OUTPUT_DIRECTORY       = docs/desktop
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and

VortexEngine/VortexCLI/Makefile

@@ -19,6 +19,9 @@ RANLIB=ranlib
 
 CFLAGS=-O2 -g -Wall
 
+# The branch/tag suffix for this device (Cli is usually desktop)
+BRANCH_SUFFIX=l
+
 # compiler defines
 DEFINES=\
 	-D VORTEX_LIB \
@@ -135,9 +138,9 @@ clean:
 
 # calculate the version number of the build
 compute_version:
-	$(eval LATEST_TAG ?= $(shell git fetch --depth=1 origin +refs/tags/*:refs/tags/* &> /dev/null && git tag --list | grep --invert-match '[a-zA-Z]' | sort -V | tail -n1))
+	$(eval LATEST_TAG ?= $(shell git fetch --depth=1 origin +refs/tags/*:refs/tags/* &> /dev/null && git tag --list "*$(BRANCH_SUFFIX)" | sort -V | tail -n1))
 	$(eval VORTEX_VERSION_MAJOR ?= $(shell echo $(LATEST_TAG) | cut -d. -f1))
-	$(eval VORTEX_VERSION_MINOR ?= $(shell echo $(LATEST_TAG) | cut -d. -f2))
+	$(eval VORTEX_VERSION_MINOR ?= $(shell echo $(LATEST_TAG) | sed 's/$(BRANCH_SUFFIX)$$//' | cut -d. -f2))
 	$(eval VORTEX_BUILD_NUMBER ?= $(shell git rev-list --count $(LATEST_TAG)..HEAD))
 	$(eval VORTEX_VERSION_MAJOR := $(if $(VORTEX_VERSION_MAJOR),$(VORTEX_VERSION_MAJOR),0))
 	$(eval VORTEX_VERSION_MINOR := $(if $(VORTEX_VERSION_MINOR),$(VORTEX_VERSION_MINOR),1))