Initial Demo

.github/workflows/release.yml

@@ -0,0 +1,95 @@
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Full history for changelog
+
+      - name: Validate tag format
+        run: |
+          TAG="${GITHUB_REF#refs/tags/}"
+          if [[ ! "$TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+)?$ ]]; then
+            echo "ERROR: Tag must match semantic version format (v1.2.3)"
+            exit 1
+          fi
+          echo "TAG=$TAG" >> $GITHUB_ENV
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install arduino-cli
+        run: |
+          curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
+          echo "$PWD/bin" >> $GITHUB_PATH
+
+      - name: Install ESP32 platform and dependencies
+        run: |
+          ${{ github.workspace }}/bin/arduino-cli config init
+          ${{ github.workspace }}/bin/arduino-cli config add board_manager.additional_urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+          ${{ github.workspace }}/bin/arduino-cli core update-index
+          ${{ github.workspace }}/bin/arduino-cli core install esp32:esp32
+          ${{ github.workspace }}/bin/arduino-cli lib install "LiquidCrystal"
+
+      - name: Build release package
+        run: |
+          chmod +x build_release.sh
+          ./build_release.sh "$TAG"
+
+      - name: Generate changelog
+        id: changelog
+        run: |
+          # Get previous tag
+          PREV_TAG=$(git describe --tags --abbrev=0 "$TAG^" 2>/dev/null || echo "")
+
+          if [ -n "$PREV_TAG" ]; then
+            echo "## Changes since $PREV_TAG" > CHANGELOG.md
+            echo "" >> CHANGELOG.md
+            git log --pretty=format:"- %s (%h)" "$PREV_TAG..$TAG" >> CHANGELOG.md
+          else
+            echo "## Initial Release" > CHANGELOG.md
+            echo "" >> CHANGELOG.md
+            echo "First release of SledLink firmware and tools." >> CHANGELOG.md
+          fi
+
+          echo "" >> CHANGELOG.md
+          echo "## Installation" >> CHANGELOG.md
+          echo "" >> CHANGELOG.md
+          echo "1. Download \`SledLink-$TAG.zip\` below" >> CHANGELOG.md
+          echo "2. Unzip the package" >> CHANGELOG.md
+          echo "3. See \`UPLOAD_GUIDE.md\` in the package for installation instructions" >> CHANGELOG.md
+
+          cat CHANGELOG.md
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          name: SledLink ${{ env.TAG }}
+          body_path: CHANGELOG.md
+          files: |
+            release/SledLink-${{ env.TAG }}.zip
+          draft: false
+          prerelease: ${{ contains(env.TAG, '-') }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-package
+          path: release/SledLink-${{ env.TAG }}.zip
+          retention-days: 30

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Compile Test
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  compile-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install arduino-cli
+        run: |
+          curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
+          echo "$PWD/bin" >> $GITHUB_PATH
+
+      - name: Install ESP32 platform
+        run: |
+          ${{ github.workspace }}/bin/arduino-cli config init
+          ${{ github.workspace }}/bin/arduino-cli config add board_manager.additional_urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+          ${{ github.workspace }}/bin/arduino-cli core update-index
+          ${{ github.workspace }}/bin/arduino-cli core install esp32:esp32
+          ${{ github.workspace }}/bin/arduino-cli lib install "LiquidCrystal"
+
+      - name: Compile SledController
+        run: |
+          ${{ github.workspace }}/bin/arduino-cli compile --fqbn esp32:esp32:esp32 arduino/SledController
+
+      - name: Compile JudgeController
+        run: |
+          ${{ github.workspace }}/bin/arduino-cli compile --fqbn esp32:esp32:esp32 arduino/JudgeController

.gitignore

@@ -50,3 +50,7 @@ Thumbs.db
 *.bak
 *.swp
 *~
+
+# Release artifacts
+release/
+*.zip

UPLOAD_GUIDE.md

@@ -2,6 +2,20 @@
 
 This guide explains how to upload firmware to your SledLink controllers. No technical knowledge is required - just follow the steps below.
 
+## Getting SledLink
+
+The latest SledLink release package is available on GitHub:
+
+**[Download Latest Release](https://github.com/thompcd/SledLink/releases/latest)**
+
+Each release includes:
+- Pre-compiled firmware binaries (ready to flash)
+- Upload and flash scripts
+- Source code
+- This guide
+
+---
+
 ## What You'll Need
 
 1. **Your SledLink controller** (either the Sled or Judge unit)

arduino/JudgeController/JudgeController.ino

@@ -20,6 +20,14 @@
 #include <esp_now.h>
 #include <LiquidCrystal.h>
 
+// ============================================================================
+// VERSION INFORMATION
+// ============================================================================
+#define FIRMWARE_DISPLAY_VERSION "v1.0.0"  // User-facing version on LCD
+#ifndef BUILD_VERSION
+  #define BUILD_VERSION "dev"               // Injected during release build
+#endif
+
 // ============================================================================
 // PIN DEFINITIONS
 // ============================================================================
@@ -106,8 +114,13 @@ void setup() {
 
   Serial.print("\r\n");
   Serial.print("========================================\r\n");
-  Serial.print("  SledLink Judge Controller v3.0\r\n");
+  Serial.print("  SledLink Judge Controller ");
+  Serial.print(FIRMWARE_DISPLAY_VERSION);
+  Serial.print("\r\n");
   Serial.print("  Tractor Pull Distance Display\r\n");
+  Serial.print("  Build: ");
+  Serial.print(BUILD_VERSION);
+  Serial.print("\r\n");
   Serial.print("========================================\r\n");
   Serial.print("\r\n");
 

arduino/SledController/SledController.ino

@@ -29,6 +29,14 @@
 #include <esp_now.h>
 #include <LiquidCrystal.h>
 
+// ============================================================================
+// VERSION INFORMATION
+// ============================================================================
+#define FIRMWARE_DISPLAY_VERSION "v1.0.0"  // User-facing version on LCD
+#ifndef BUILD_VERSION
+  #define BUILD_VERSION "dev"               // Injected during release build
+#endif
+
 // ============================================================================
 // PIN DEFINITIONS
 // ============================================================================
@@ -150,8 +158,13 @@ void setup() {
 
   Serial.print("\r\n");
   Serial.print("========================================\r\n");
-  Serial.print("  SledLink Sled Controller v3.0\r\n");
+  Serial.print("  SledLink Sled Controller ");
+  Serial.print(FIRMWARE_DISPLAY_VERSION);
+  Serial.print("\r\n");
   Serial.print("  Tractor Pull Distance Measurement\r\n");
+  Serial.print("  Build: ");
+  Serial.print(BUILD_VERSION);
+  Serial.print("\r\n");
   Serial.print("========================================\r\n");
   Serial.print("\r\n");
 

build_release.sh

@@ -7,7 +7,21 @@
 set -e
 
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-VERSION="${1:-$(date +%Y.%m.%d)}"
+
+# Version handling with validation
+if [ -n "$1" ]; then
+  VERSION="$1"
+  # Validate semantic version format (v1.2.3) or date format (YYYY.MM.DD)
+  if [[ ! "$VERSION" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+)?$ ]] && \
+     [[ ! "$VERSION" =~ ^[0-9]{4}\.[0-9]{2}\.[0-9]{2}$ ]]; then
+    echo "ERROR: Invalid version format: $VERSION"
+    echo "Expected: v1.2.3, v1.2.3-beta, or YYYY.MM.DD"
+    exit 1
+  fi
+else
+  VERSION="$(date +%Y.%m.%d)"
+fi
+
 RELEASE_DIR="$SCRIPT_DIR/release"
 RELEASE_NAME="SledLink-$VERSION"
 OUTPUT_DIR="$RELEASE_DIR/$RELEASE_NAME"
@@ -105,12 +119,19 @@ cp "$SCRIPT_DIR/UPLOAD_GUIDE.md" "$OUTPUT_DIR/"
 cp "$SCRIPT_DIR/docs/README.md" "$OUTPUT_DIR/docs_README.md" 2>/dev/null || true
 
 # Create release README
-cat > "$OUTPUT_DIR/README.txt" << 'HEREDOC'
+cat > "$OUTPUT_DIR/README.txt" << HEREDOC
 ================================================================================
-  SledLink Firmware Release
+  SledLink Firmware Release $VERSION
   Tractor Pull Distance Measurement System
 ================================================================================
 
+RELEASE INFORMATION
+-------------------
+  Version:        $VERSION
+  Firmware:       v1.0.0
+  Build Date:     $(date +%Y-%m-%d)
+  Download:       https://github.com/thompcd/SledLink/releases/tag/$VERSION
+
 This release contains pre-compiled firmware and tools for the SledLink system.
 
 CONTENTS