name: Build and Package Firmware

on:
  push:
    branches:
      - '*'
    tags:
      - 'v*'

jobs:
  build:
    runs-on: ubuntu-latest
    container: espressif/idf:v5.2.1
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Configure Safe Directory
        run: |
          git config --global --add safe.directory "*"

      - name: Set Version Identifier
        run: |
          git rev-parse --short HEAD > version.txt && echo "Build version (commit ID): $(cat version.txt)"

      - name: Build and Run Host Unit Tests
        run: |
          cmake -S tests -B tests/build && cmake --build tests/build && ./tests/build/test_decoder

      - name: Build Firmware
        run: |
          . $IDF_PATH/export.sh && idf.py build

      - name: Create Flashing Instructions Document
        run: |
          mkdir -p dist && cat << 'EOF' > dist/README_FLASHING.txt
          ESP32 ALDL Bridge Firmware Flash Instructions
          =============================================

          Prerequisites:
          - Python 3 installed
          - esptool installed: pip install esptool

          Connect your ESP32 to your PC, identify its serial port, and run the following command to flash:

          esptool.py --chip esp32 -b 460800 --before default_reset --after hard_reset write_flash --flash_mode dio --flash_size 2MB --flash_freq 40m 0x1000 bootloader.bin 0x8000 partition-table.bin 0x10000 esp32-aldl.bin
          EOF

      - name: Stage Firmware Binaries
        run: |
          cp build/esp32-aldl.bin dist/ && cp build/bootloader/bootloader.bin dist/ && cp build/partition_table/partition-table.bin dist/

      - name: Package Release
        run: |
          tar -czvf esp32-aldl-firmware.tar.gz -C dist .

      # ---------------------------------------------------------------
      # Conditional Artifact Uploads for Cross-Platform Compatibility
      # ---------------------------------------------------------------

      - name: Upload Firmware Package (GitHub)
        if: ${{ github.server_url == 'https://github.com' }}
        uses: actions/upload-artifact@v4
        with:
          name: esp32-aldl-firmware-${{ github.sha }}
          path: esp32-aldl-firmware.tar.gz
          if-no-files-found: error

      - name: Upload Firmware Package (Gitea)
        if: ${{ github.server_url != 'https://github.com' }}
        uses: actions/upload-artifact@v3
        with:
          name: esp32-aldl-firmware-${{ github.sha }}
          path: esp32-aldl-firmware.tar.gz
          if-no-files-found: error