esp-logger/.github/workflows/ci.yml at main · ESPToolKit/esp-logger · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
name: CI

on:
  push:
    branches: [ main, master ]
    tags: ['v*']
  pull_request:
  workflow_dispatch:

jobs:
  source-audit:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Audit production sources
        run: |
          if rg -n '\bthrow\b|std::abort\(' src; then
            echo "Embedded safety audit failed"
            exit 1
          fi

  unit-tests:
    runs-on: ubuntu-latest
    needs: source-audit
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Configure CMake
        run: cmake -S . -B build

      - name: Build tests
        run: cmake --build build

      - name: Run tests
        run: ctest --test-dir build --output-on-failure

  build-examples:
    runs-on: ubuntu-latest
    needs: unit-tests
    strategy:
      fail-fast: false
      matrix:
        board: [esp32dev, esp32-s3-devkitc-1, esp32-c3-devkitm-1, esp32-p4-evboard]
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.13'

      - name: Cache PlatformIO
        uses: actions/cache@v4
        with:
          path: ~/.platformio
          key: ${{ runner.os }}-platformio-pioarduino-6.1.19-${{ hashFiles('**/library.json') }}
          restore-keys: |
            ${{ runner.os }}-platformio-pioarduino-6.1.19-

      - name: Install PIOArduino Core
        run: python -m pip install --upgrade https://github.com/pioarduino/platformio-core/archive/refs/tags/v6.1.19.zip

      - name: Install PIOArduino ESP32 Platform
        run: pio pkg install -g -p https://github.com/pioarduino/platform-espressif32.git

      - name: Build library examples (ESP32 Arduino)
        run: |
          set -e
          for d in examples/*; do
            if [ -d "$d" ]; then
              echo "Building $d on ${{ matrix.board }} via PlatformIO CI"
              EXTRA_LIB_DEPS=
              if [ "$(basename "$d")" = "json_logging" ]; then
                EXTRA_LIB_DEPS='--project-option lib_deps=bblanchon/ArduinoJson@^7.0.0'
              fi
              # Force C++17 for this project to satisfy library requirements
              pio ci "$d" \
                --board ${{ matrix.board }} \
                --lib="." \
                --project-option "platform=https://github.com/pioarduino/platform-espressif32.git" \
                --project-option "build_unflags=-std=gnu++11" \
                --project-option "build_flags=-std=gnu++17" \
                ${EXTRA_LIB_DEPS}
            fi
          done

  arduino-cli:
    runs-on: ubuntu-latest
    needs: unit-tests
    strategy:
      fail-fast: false
      matrix:
        board:
          - fqbn: esp32:esp32:esp32
            name: esp32dev
          - fqbn: esp32:esp32:esp32s3
            name: esp32-s3-devkitc-1
          - fqbn: esp32:esp32:esp32c3
            name: esp32-c3-devkitm-1
          - fqbn: esp32:esp32:esp32p4
            name: esp32-p4-evboard
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Arduino CLI
        uses: arduino/setup-arduino-cli@v1

      - name: Install ESP32 core
        run: |
          arduino-cli core update-index
          arduino-cli core install esp32:esp32

      - name: Install libraries
        run: |
          arduino-cli lib update-index
          # Use correct Library Manager names
          arduino-cli lib install "ArduinoJson" "StreamUtils"
          if [ ! -d "${HOME}/Arduino/libraries/ESPBufferManager" ]; then
            arduino-cli lib install --git-url https://github.com/ESPToolKit/esp-buffer-manager.git || \
              git clone --depth 1 https://github.com/ESPToolKit/esp-buffer-manager.git "${HOME}/Arduino/libraries/ESPBufferManager"
          fi
          if [ ! -d "${HOME}/Arduino/libraries/ESPWorker" ]; then
            arduino-cli lib install --git-url https://github.com/ESPToolKit/esp-worker.git || \
              git clone --depth 1 https://github.com/ESPToolKit/esp-worker.git "${HOME}/Arduino/libraries/ESPWorker"
          fi

      - name: Add local library to sketchbook
        run: |
          set -e
          SKETCHBOOK_DIR="${HOME}/Arduino"
          mkdir -p "$SKETCHBOOK_DIR/libraries/ESPLogger"
          rsync -a --delete --exclude ".git" ./ "$SKETCHBOOK_DIR/libraries/ESPLogger/"

      - name: Build examples (${{ matrix.board.name }})
        env:
          FQBN: ${{ matrix.board.fqbn }}
        run: |
          set -e
          for d in examples/*; do
            if [ -d "$d" ]; then
              echo "Compiling $d"
              arduino-cli compile --fqbn "$FQBN" "$d"
            fi
          done