From 9f8d86cb25febfb86c57f395549b7deb82458065 Mon Sep 17 00:00:00 2001
From: Jason Murray <15822260+scruplelesswizard@users.noreply.github.com>
Date: Sun, 22 Sep 2024 04:22:00 -0700
Subject: [PATCH] Consolidate variant build steps (#4806)

* poc: consolidate variant build steps

* use build-variant action

* only checkout once and clean up after run
---
 .github/actions/build-variant/action.yml | 97 ++++++++++++++++++++++++
 .github/workflows/build_esp32.yml        | 60 ++++-----------
 .github/workflows/build_esp32_c3.yml     | 59 ++++----------
 .github/workflows/build_esp32_s3.yml     | 60 ++++-----------
 .github/workflows/build_nrf52.yml        | 22 ++----
 .github/workflows/build_rpi2040.yml      | 22 ++----
 .github/workflows/build_stm32.yml        | 24 ++----
 7 files changed, 159 insertions(+), 185 deletions(-)
 create mode 100644 .github/actions/build-variant/action.yml

diff --git a/.github/actions/build-variant/action.yml b/.github/actions/build-variant/action.yml
new file mode 100644
index 000000000..0a96a0155
--- /dev/null
+++ b/.github/actions/build-variant/action.yml
@@ -0,0 +1,97 @@
+name: Setup Build Variant Composite Action
+description: Variant build actions for Meshtastic Platform IO steps
+
+inputs:
+  board:
+    description: The board to build for
+    required: true
+  github_token:
+    description: GitHub token
+    required: true
+  build-script-path:
+    description: Path to the build script
+    required: true
+  remove-debug-flags:
+    description: A newline separated list of files to remove debug flags from
+    required: false
+    default: ""
+  ota-firmware-source:
+    description: The OTA firmware file to pull
+    required: false
+    default: ""
+  ota-firmware-target:
+    description: The target path to store the OTA firmware file
+    required: false
+    default: ""
+  artifact-paths:
+    description: A newline separated list of paths to store as artifacts
+    required: false
+    default: ""
+  include-web-ui:
+    description: Include the web UI in the build
+    required: false
+    default: "false"
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/checkout@v4
+
+    - name: Build base
+      id: base
+      uses: ./.github/actions/setup-base
+
+    - name: Pull web ui
+      if: ${{ inputs.include-web-ui == "true" }}
+      uses: dsaltares/fetch-gh-release-asset@master
+      with:
+        repo: meshtastic/web
+        file: build.tar
+        target: build.tar
+        token: ${{ inputs.github_token }}
+
+    - name: Unpack web ui
+      if: ${{ inputs.include-web-ui == "true" }}
+      shell: bash
+      run: |
+        tar -xf build.tar -C data/static
+        rm build.tar
+
+    - name: Remove debug flags for release
+      shell: bash
+      if: ${{ inputs.remove-debug-flags != "" }}
+      run: |
+        for PATH in ${{ inputs.remove-debug-flags }}; do
+          sed -i '/DDEBUG_HEAP/d' ${PATH}
+        done
+
+    - name: Build ${{ inputs.board }}
+      shell: bash
+      run: ${{ inputs.build-script-path }} ${{ inputs.board }}
+
+    - name: Pull OTA Firmware
+      if: ${{ inputs.ota-firmware-source != "" && inputs.ota-firmware-target != "" }}
+      uses: dsaltares/fetch-gh-release-asset@master
+      with:
+        repo: meshtastic/firmware-ota
+        file: ${{ inputs.ota-firmware-source }}
+        target: ${{ inputs.ota-firmware-target }}
+        token: ${{ inputs.github_token }}
+
+    - name: Get release version string
+      shell: bash
+      run: echo "version=$(./bin/buildinfo.py long)" >> $GITHUB_OUTPUT
+      id: version
+
+    - name: Store binaries as an artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: firmware-${{ inputs.board }}-${{ steps.version.outputs.version }}.zip
+        overwrite: true
+        path: |
+          ${{ inputs.artifact-paths }}
+
+    - name: Clean up resources
+      shell: bash
+      run: |
+        rm -rf .
diff --git a/.github/workflows/build_esp32.yml b/.github/workflows/build_esp32.yml
index 4cbb4c7a4..8b7017fc9 100644
--- a/.github/workflows/build_esp32.yml
+++ b/.github/workflows/build_esp32.yml
@@ -11,53 +11,21 @@ jobs:
   build-esp32:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Build base
-        id: base
-        uses: ./.github/actions/setup-base
-
-      - name: Pull web ui
-        uses: dsaltares/fetch-gh-release-asset@master
-        with:
-          repo: meshtastic/web
-          file: build.tar
-          target: build.tar
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Unpack web ui
-        run: |
-          tar -xf build.tar -C data/static
-          rm build.tar
-
-      - name: Remove debug flags for release
-        if: ${{ github.event_name == 'workflow_dispatch' }}
-        run: |
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32s2.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32s3.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32c3.ini
-
       - name: Build ESP32
-        run: bin/build-esp32.sh ${{ inputs.board }}
-
-      - name: Pull OTA Firmware
-        uses: dsaltares/fetch-gh-release-asset@master
+        id: build
+        uses: ./.github/actions/build-variant
         with:
-          repo: meshtastic/firmware-ota
-          file: firmware.bin
-          target: release/bleota.bin
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Get release version string
-        shell: bash
-        run: echo "version=$(./bin/buildinfo.py long)" >> $GITHUB_OUTPUT
-        id: version
-
-      - name: Store binaries as an artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: firmware-${{ inputs.board }}-${{ steps.version.outputs.version }}.zip
-          overwrite: true
-          path: |
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          board: ${{ inputs.board }}
+          remove-debug-flags: |
+            ./arch/esp32/esp32.ini
+            ./arch/esp32/esp32s2.ini
+            ./arch/esp32/esp32s3.ini
+            ./arch/esp32/esp32c3.ini
+          build-script-path: bin/build-esp32.sh
+          ota-firmware-source: firmware.bin
+          ota-firmware-target: release/bleota.bin
+          artifact-paths: |
             release/*.bin
             release/*.elf
+          include-web-ui: true
diff --git a/.github/workflows/build_esp32_c3.yml b/.github/workflows/build_esp32_c3.yml
index 07727d711..249f6f126 100644
--- a/.github/workflows/build_esp32_c3.yml
+++ b/.github/workflows/build_esp32_c3.yml
@@ -13,51 +13,20 @@ jobs:
   build-esp32-c3:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Build base
-        id: base
-        uses: ./.github/actions/setup-base
-
-      - name: Pull web ui
-        uses: dsaltares/fetch-gh-release-asset@master
+      - name: Build ESP32-C3
+        id: build
+        uses: ./.github/actions/build-variant
         with:
-          repo: meshtastic/web
-          file: build.tar
-          target: build.tar
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Unpack web ui
-        run: |
-          tar -xf build.tar -C data/static
-          rm build.tar
-      - name: Remove debug flags for release
-        if: ${{ github.event_name == 'workflow_dispatch' }}
-        run: |
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32s2.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32s3.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32c3.ini
-      - name: Build ESP32
-        run: bin/build-esp32.sh ${{ inputs.board }}
-
-      - name: Pull OTA Firmware
-        uses: dsaltares/fetch-gh-release-asset@master
-        with:
-          repo: meshtastic/firmware-ota
-          file: firmware-c3.bin
-          target: release/bleota-c3.bin
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Get release version string
-        shell: bash
-        run: echo "version=$(./bin/buildinfo.py long)" >> $GITHUB_OUTPUT
-        id: version
-
-      - name: Store binaries as an artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: firmware-${{ inputs.board }}-${{ steps.version.outputs.version }}.zip
-          overwrite: true
-          path: |
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          board: ${{ inputs.board }}
+          remove-debug-flags: |
+            ./arch/esp32/esp32.ini
+            ./arch/esp32/esp32s2.ini
+            ./arch/esp32/esp32s3.ini
+            ./arch/esp32/esp32c3.ini
+          build-script-path: bin/build-esp32.sh
+          ota-firmware-source: firmware-c3.bin
+          ota-firmware-target: release/bleota-c3.bin
+          artifact-paths: |
             release/*.bin
             release/*.elf
diff --git a/.github/workflows/build_esp32_s3.yml b/.github/workflows/build_esp32_s3.yml
index 10773833e..7df3e5737 100644
--- a/.github/workflows/build_esp32_s3.yml
+++ b/.github/workflows/build_esp32_s3.yml
@@ -11,51 +11,21 @@ jobs:
   build-esp32-s3:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Build base
-        id: base
-        uses: ./.github/actions/setup-base
-
-      - name: Pull web ui
-        uses: dsaltares/fetch-gh-release-asset@master
+      - name: Build ESP32-S3
+        id: build
+        uses: ./.github/actions/build-variant
         with:
-          repo: meshtastic/web
-          file: build.tar
-          target: build.tar
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Unpack web ui
-        run: |
-          tar -xf build.tar -C data/static
-          rm build.tar
-      - name: Remove debug flags for release
-        if: ${{ github.event_name == 'workflow_dispatch' }}
-        run: |
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32s2.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32s3.ini
-          sed -i '/DDEBUG_HEAP/d' ./arch/esp32/esp32c3.ini
-      - name: Build ESP32
-        run: bin/build-esp32.sh ${{ inputs.board }}
-
-      - name: Pull OTA Firmware
-        uses: dsaltares/fetch-gh-release-asset@master
-        with:
-          repo: meshtastic/firmware-ota
-          file: firmware-s3.bin
-          target: release/bleota-s3.bin
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Get release version string
-        shell: bash
-        run: echo "version=$(./bin/buildinfo.py long)" >> $GITHUB_OUTPUT
-        id: version
-
-      - name: Store binaries as an artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: firmware-${{ inputs.board }}-${{ steps.version.outputs.version }}.zip
-          overwrite: true
-          path: |
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          board: ${{ inputs.board }}
+          remove-debug-flags: |
+            ./arch/esp32/esp32.ini
+            ./arch/esp32/esp32s2.ini
+            ./arch/esp32/esp32s3.ini
+            ./arch/esp32/esp32c3.ini
+          build-script-path: bin/build-esp32.sh
+          ota-firmware-source: firmware-s3.bin
+          ota-firmware-target: release/bleota-s3.bin
+          artifact-paths: |
             release/*.bin
             release/*.elf
+          include-web-ui: true
diff --git a/.github/workflows/build_nrf52.yml b/.github/workflows/build_nrf52.yml
index ac509a096..85d3635cd 100644
--- a/.github/workflows/build_nrf52.yml
+++ b/.github/workflows/build_nrf52.yml
@@ -11,24 +11,14 @@ jobs:
   build-nrf52:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Build base
-        id: base
-        uses: ./.github/actions/setup-base
-
       - name: Build NRF52
-        run: bin/build-nrf52.sh ${{ inputs.board }}
-
-      - name: Get release version string
-        run: echo "version=$(./bin/buildinfo.py long)" >> $GITHUB_OUTPUT
-        id: version
-
-      - name: Store binaries as an artifact
-        uses: actions/upload-artifact@v4
+        id: build
+        uses: ./.github/actions/build-variant
         with:
-          name: firmware-${{ inputs.board }}-${{ steps.version.outputs.version }}.zip
-          overwrite: true
-          path: |
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          board: ${{ inputs.board }}
+          build-script-path: bin/build-nrf52.sh
+          artifact-paths: |
             release/*.hex
             release/*.uf2
             release/*.elf
diff --git a/.github/workflows/build_rpi2040.yml b/.github/workflows/build_rpi2040.yml
index 6e258fe2a..d3e19f8fd 100644
--- a/.github/workflows/build_rpi2040.yml
+++ b/.github/workflows/build_rpi2040.yml
@@ -11,23 +11,13 @@ jobs:
   build-rpi2040:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Build base
-        id: base
-        uses: ./.github/actions/setup-base
-
       - name: Build Raspberry Pi 2040
-        run: ./bin/build-rpi2040.sh ${{ inputs.board }}
-
-      - name: Get release version string
-        run: echo "version=$(./bin/buildinfo.py long)" >> $GITHUB_OUTPUT
-        id: version
-
-      - name: Store binaries as an artifact
-        uses: actions/upload-artifact@v4
+        id: build
+        uses: ./.github/actions/build-variant
         with:
-          name: firmware-${{ inputs.board }}-${{ steps.version.outputs.version }}.zip
-          overwrite: true
-          path: |
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          board: ${{ inputs.board }}
+          build-script-path: bin/build-rpi2040.sh
+          artifact-paths: |
             release/*.uf2
             release/*.elf
diff --git a/.github/workflows/build_stm32.yml b/.github/workflows/build_stm32.yml
index d13c52c8a..9252087df 100644
--- a/.github/workflows/build_stm32.yml
+++ b/.github/workflows/build_stm32.yml
@@ -11,23 +11,13 @@ jobs:
   build-stm32:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Build base
-        id: base
-        uses: ./.github/actions/setup-base
-
-      - name: Build STM32
-        run: bin/build-stm32.sh ${{ inputs.board }}
-
-      - name: Get release version string
-        run: echo "version=$(./bin/buildinfo.py long)" >> $GITHUB_OUTPUT
-        id: version
-
-      - name: Store binaries as an artifact
-        uses: actions/upload-artifact@v4
+      - name: Build Raspberry Pi 2040
+        id: build
+        uses: ./.github/actions/build-variant
         with:
-          name: firmware-${{ inputs.board }}-${{ steps.version.outputs.version }}.zip
-          overwrite: true
-          path: |
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          board: ${{ inputs.board }}
+          build-script-path: bin/build-stm32.sh
+          artifact-paths: |
             release/*.hex
             release/*.bin