From ae39914987ecf1540419d77c3c9c708024939562 Mon Sep 17 00:00:00 2001
From: Sara Damiano <sdamiano@stroudcenter.org>
Date: Tue, 28 May 2024 14:46:41 -0400
Subject: [PATCH] Fix CI lib install source

Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
---
 .../workflows/build_examples_platformio.yaml  | 63 +++++++++++++++++--
 1 file changed, 58 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/build_examples_platformio.yaml b/.github/workflows/build_examples_platformio.yaml
index 0a5b1486..01c5eee1 100644
--- a/.github/workflows/build_examples_platformio.yaml
+++ b/.github/workflows/build_examples_platformio.yaml
@@ -8,9 +8,62 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build:
+  determine_library_source:
+    name: determine_library_source
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, 'ci skip')"
+    outputs:
+      library_install_zip: ${{ steps.store_vars.outputs.library_install_zip }}
+      library_install_git: ${{ steps.store_vars.outputs.library_install_git }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set environment variables for pushes to any branch
+        if: github.event_name == 'push'
+        run: |
+          echo "Push to commit ${GITHUB_SHA}"
+          echo "LIBRARY_INSTALL_ZIP=https://github.com/${GITHUB_REPOSITORY}/archive/${GITHUB_SHA}.zip" >> $GITHUB_ENV
+          echo "LIBRARY_INSTALL_GIT=https://github.com/${GITHUB_REPOSITORY}.git#${GITHUB_SHA}" >> $GITHUB_ENV
+
+      - name: Set environment variable for PR's from any branch
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.name == github.repository
+        run: |
+          echo "Pull Request from the ${GITHUB_HEAD_REF} branch"
+          echo "LIBRARY_INSTALL_ZIP=https://github.com/${GITHUB_REPOSITORY}/archive/${GITHUB_HEAD_REF}.zip" >> $GITHUB_ENV
+          echo "LIBRARY_INSTALL_GIT=https://github.com/${GITHUB_REPOSITORY}.git#${GITHUB_HEAD_REF}" >> $GITHUB_ENV
+
+      - name: Set environment variable for PR's from any branch
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.name != github.repository
+        run: |
+          echo "Pull Request from the fork ${{ github.event.pull_request.head.repo.full_name }} at ${{ github.event.pull_request.head.ref }}"
+          echo "LIBRARY_INSTALL_ZIP=https://github.com/${{ github.event.pull_request.head.repo.full_name }}/archive/${{ github.event.pull_request.head.ref }}.zip" >> $GITHUB_ENV
+          echo "LIBRARY_INSTALL_GIT=https://github.com/${{ github.event.pull_request.head.repo.full_name }}.git#${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV
+
+      - name: store enviroment variables as output
+        id: store_vars
+        run: |
+          echo "library_install_zip=${{ env.LIBRARY_INSTALL_ZIP }}" >> $GITHUB_OUTPUT
+          echo "library_install_git=${{ env.LIBRARY_INSTALL_GIT }}" >> $GITHUB_OUTPUT
+
+  print_library_source:
+    name: print_library_source
+    runs-on: ubuntu-latest
+    needs: determine_library_source
+    steps:
+      - name: Check the library installation source
+        run: |
+          echo "Link to zip for Arduino CLI testing install:"
+          echo "${{ needs.determine_library_source.outputs.library_install_zip }}"
+          echo
+          echo "Git reference for PlatformIO testing install"
+          echo "${{ needs.determine_library_source.outputs.library_install_git }}"
+
+  build_pio:
+    runs-on: ubuntu-latest
+    needs: [determine_library_source]
+    env:
+      LIBRARY_INSTALL_GIT: ${{ needs.determine_library_source.outputs.library_install_git }}
 
     strategy:
       matrix:
@@ -70,7 +123,7 @@ jobs:
           python -m pip install --upgrade pip
           pip install --upgrade platformio
 
-      - name: Restore or Cache Platforms and Libraries
+      - name: Restore or Cache PlatformIO Platforms and Libraries
         uses: actions/cache@v4
         id: cache_pio
         with:
@@ -81,7 +134,7 @@ jobs:
           key: ${{ hashFiles('./examples/example_dependencies.json') }}
 
       # Install cores and library dependencies for the Arduino CLI, iff no cache
-      - name: Install the Arduino libraries
+      - name: Install the Arduino libraries for PlatformIO
         if: steps.cache_pio.outputs.cache-hit != 'true'
         run: pio lib --global install 89 415 1202 1286
 
@@ -90,8 +143,8 @@ jobs:
           PLATFORMIO_CI_SRC: ${{ matrix.example }}
           TINYGSM_MODEM_TO_USE: ${{ matrix.modem }}
         run: |
-          echo "${{ env.LIBRARY_INSTALL_SOURCE }}"
-          pio lib --global install ${{ env.LIBRARY_INSTALL_SOURCE }}
+          echo "${{ env.LIBRARY_INSTALL_GIT }}"
+          pio pkg install -g --library ${{ env.LIBRARY_INSTALL_GIT }}
           sed -i 's/\/\/ #define TINY_GSM_MODEM_SIM800/#define TINY_GSM_MODEM_SIM800/g' ${{ matrix.example }}/*
           platformio ci --project-option='build_flags=-D ${{ env.TINYGSM_MODEM_TO_USE }}' --project-option='framework=arduino' --board=uno --board=leonardo --board=yun --board=megaatmega2560 --board=genuino101 --board=mkr1000USB --board=zero --board=teensy31 --board=bluepill_f103c8 --board=uno_pic32 --board=esp01 --board=nodemcuv2 --board=esp32dev
           pio lib --global uninstall TinyGSM