Spark Audit

.github/workflows/spark_build.yml

@@ -0,0 +1,181 @@
+name: Spark Build
+
+on:
+  push:
+    branches: [ "spark" ]
+  pull_request:
+    branches: [ "spark" ]
+  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="s"
+          # 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
+
+  embedded:
+    needs: [setup, test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Install Dependencies
+        run: make install
+      - name: Build Binary
+        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 build
+      - name: Zip firmware files
+        run: |
+          zip SparkFirmware.zip \
+            build/VortexEngine.ino.bootloader.bin \
+            build/VortexEngine.ino.partitions.bin \
+            ~/.arduino15/packages/esp32/hardware/esp32/3.0.4/tools/partitions/boot_app0.bin \
+            build/VortexEngine.ino.bin
+      - name: Archive firmware zip
+        uses: actions/upload-artifact@v4
+        with:
+          name: spark-firmware-zip
+          path: SparkFirmware.zip
+
+  wasm:
+    needs: [setup, test, embedded]
+    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
+
+  docs:
+    #todo: fix the depends to be setup, test, embedded, wasm
+    needs: [setup, test]
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/spark'
+    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/spark
+          doxygen Doxyfile
+          echo "Listing contents of docs/spark:"
+          ls -R docs/spark || echo "No files found in docs/spark"
+      - name: Upload Doxygen Documentation as Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: doxygen-docs-spark
+          path: docs/spark
+
+  deploy:
+    needs: [setup, test, embedded, wasm, docs]
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/spark'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: spark-firmware-zip
+          path: build
+      - name: Rename and Deploy Firmware
+        run: |
+          DEVICE_TYPE="spark"
+          VERSIONED_FILENAME="VortexEngine-${DEVICE_TYPE}-${{ needs.setup.outputs.vortex_version_number }}.zip"
+          mv build/SparkFirmware.zip build/$VERSIONED_FILENAME
+          echo "Version is ${{ needs.setup.outputs.vortex_version_number }}"
+          echo "Filename is $VERSIONED_FILENAME"
+          curl -X POST \
+            -F "file=@build/$VERSIONED_FILENAME" \
+            -F "device=$DEVICE_TYPE" \
+            -F "version=${{ needs.setup.outputs.vortex_version_number }}" \
+            -F "category=firmware" \
+            -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/spark
 
 # 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

Makefile

@@ -0,0 +1,66 @@
+.PHONY: all install build upload clean compute_version
+
+ARDUINO_CLI = ./bin/arduino-cli --verbose
+BOARD = esp32:esp32:XIAO_ESP32C3
+PORT = COMx # Replace 'x' with the appropriate COM port number
+PROJECT_NAME = VortexEngine/VortexEngine.ino
+BUILD_PATH = build
+CONFIG_FILE = $(HOME)/.arduino15/arduino-cli.yaml
+
+# The branch/tag suffix for this device
+BRANCH_SUFFIX=s
+
+DEFINES=\
+	-D VORTEX_VERSION_MAJOR=$(VORTEX_VERSION_MAJOR) \
+	-D VORTEX_VERSION_MINOR=$(VORTEX_VERSION_MINOR) \
+	-D VORTEX_BUILD_NUMBER=$(VORTEX_BUILD_NUMBER) \
+	-D VORTEX_VERSION_NUMBER=$(VORTEX_VERSION_NUMBER) \
+	-MMD -c #due to a bug need the -MMD and -c otherwise esp won't build
+
+# Default target
+all: build
+
+update-index:
+	$(ARDUINO_CLI) core update-index
+
+install:
+	sudo apt-get update
+	sudo apt-get install -y build-essential
+	pip install pyserial
+	mkdir -p $(HOME)/.arduino15
+	if ! command -v $(ARDUINO_CLI) &> /dev/null ; then \
+		curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sudo sh ; \
+	fi
+	echo 'board_manager: \n  additional_urls: \n    - https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json' | sudo tee $(CONFIG_FILE)
+	$(ARDUINO_CLI) lib update-index
+	$(ARDUINO_CLI) core update-index --config-file $(CONFIG_FILE)
+	$(ARDUINO_CLI) core install esp32:esp32 --config-file $(CONFIG_FILE)
+	$(ARDUINO_CLI) lib install [email protected]
+
+build: compute_version
+	$(ARDUINO_CLI) compile --fqbn $(BOARD) $(PROJECT_NAME) \
+		--config-file $(CONFIG_FILE) \
+		--build-path $(BUILD_PATH) \
+		--build-property compiler.cpp.extra_flags="$(DEFINES)" \
+		--build-property compiler.c.extra_flags="$(DEFINES)"
+	@echo "== Success building Spark v$(VORTEX_VERSION_NUMBER) =="
+
+upload:
+	$(ARDUINO_CLI) upload -p $(PORT) --fqbn $(BOARD) $(PROJECT_NAME) --config-file $(CONFIG_FILE)
+
+core-list:
+	$(ARDUINO_CLI) core list
+
+clean:
+	rm -rf $(BUILD_PATH)
+
+# 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 "*$(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) | 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))
+	$(eval VORTEX_BUILD_NUMBER := $(if $(VORTEX_BUILD_NUMBER),$(VORTEX_BUILD_NUMBER),0))
+	$(eval VORTEX_VERSION_NUMBER := $(VORTEX_VERSION_MAJOR).$(VORTEX_VERSION_MINOR).$(VORTEX_BUILD_NUMBER))