From db4166830b37ec7810be813d1b092f5f434d4b77 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Wed, 31 May 2023 12:12:42 +1200 Subject: [PATCH 01/17] chore(ci): Build CRSF for Arduino using PlatformIO via GH Actions CI --- .github/workflows/build.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 00000000..6091eef7 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,24 @@ +name: Build CRSF for Arduino + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - uses: actions/cache@v3 + with: + path: | + ~/.cache/pip + ~/.platformio/.cache + key: ${{ runner.os }}-pio + - uses: actions/setup-python@v4 + with: + python-version: '3.9' + - name: Install PlatformIO Core + run: pip install --upgrade platformio + + - name: Build PlatformIO Project + run: pio run From 8af7c9c6ba88ee7b83896f09647e55b866b18c27 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Fri, 2 Jun 2023 11:01:33 +1200 Subject: [PATCH 02/17] ci(ci): Remove `repository_dispatch` trigger from githubci.yml --- .github/workflows/githubci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index 874aca86..c886fcee 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -1,6 +1,6 @@ name: Arduino Library CI -on: [pull_request, push, repository_dispatch] +on: [pull_request, push] jobs: build: From f71e70c4350c123b6195cffd4d0731a4a71da9c8 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Fri, 2 Jun 2023 11:02:48 +1200 Subject: [PATCH 03/17] ci(ci): Add Adafruit CI to github.yml --- .github/workflows/githubci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index c886fcee..c574e922 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -13,8 +13,8 @@ jobs: - uses: actions/checkout@v2 - uses: actions/checkout@v2 with: - repository: adafruit/ci-arduino - path: ci + repository: adafruit/ci-arduino + path: ci - name: Install the prerequisites run: bash ci/actions_install.sh From 35032ba82a70783be044a500547a36ca73ef3658 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 10:21:26 +1200 Subject: [PATCH 04/17] ci(ci): Remove `pull_request` trigger from githubci.yml --- .github/workflows/githubci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index c574e922..d9ad1e18 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -1,6 +1,6 @@ name: Arduino Library CI -on: [pull_request, push] +on: [push] jobs: build: From 634ec2a05f900532ec8df37e13e629e7f9be87da Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 11:08:40 +1200 Subject: [PATCH 05/17] ci(ci): Bump Arduino CI versions --- .github/workflows/githubci.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index d9ad1e18..9bff769a 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -7,11 +7,11 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/setup-python@v1 + - uses: actions/setup-python@v4 with: python-version: '3.x' - - uses: actions/checkout@v2 - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 + - uses: actions/checkout@v3 with: repository: adafruit/ci-arduino path: ci From 3b65f180c4bbb427aa43da70f4e30c3c52861171 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 11:15:55 +1200 Subject: [PATCH 06/17] ci(test-attempt 1): Temporarily reinstate testing on supported platforms This is a part of an ongoing test to see if CI will verify CRSF for Arduino on supported Arduino IDE platforms --- .github/workflows/githubci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index 9bff769a..06abd264 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -32,5 +32,5 @@ jobs: # Temporarily disable testing on Metro M4, for now. # For some reason, it is returning "No such file or directory" on CRSFforArduino.h # Further investigation is needed. -# - name: Test the code on supported platforms -# run: python3 ci/build_platform.py metro_m4 + - name: Test the code on supported platforms + run: python3 ci/build_platform.py metro_m4 From 8bac978f43cd4c572eddbe2fc4e16cdcaa8dcb10 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 11:23:38 +1200 Subject: [PATCH 07/17] build(test-attempt 2): Add `.h` to the end of `Adafruit_ZeroDMA` dependency This is a part of an ongoing test to see if CI will verify CRSF for Arduino on supported Arduino IDE platforms --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index cd9b4327..e08d02a1 100644 --- a/library.properties +++ b/library.properties @@ -6,6 +6,6 @@ sentence=An Arduino Library for communicating with ExpressLRS receivers. paragraph=This library brings the CRSF protocol to the Arduino platform. It is compatible with ExpressLRS & Crossfire receivers. category=Communication url=https://github.com/ZZ-Cat/CRSFforArduino -depends=Adafruit_ZeroDMA +depends=Adafruit_ZeroDMA.h dot_a_linkage=false includes=CRSFforArduino.h From dedc482c728f74158c272ed881d506983a6e99bc Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 11:39:36 +1200 Subject: [PATCH 08/17] build(test-attempt 3): Rename `Adafruit_ZeroDMA.h` dependency to `Adafruit Zero DMA Library` This is a part of an ongoing test to see if CI will verify CRSF for Arduino on supported Arduino IDE platforms --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index e08d02a1..f691c043 100644 --- a/library.properties +++ b/library.properties @@ -6,6 +6,6 @@ sentence=An Arduino Library for communicating with ExpressLRS receivers. paragraph=This library brings the CRSF protocol to the Arduino platform. It is compatible with ExpressLRS & Crossfire receivers. category=Communication url=https://github.com/ZZ-Cat/CRSFforArduino -depends=Adafruit_ZeroDMA.h +depends=Adafruit Zero DMA Library dot_a_linkage=false includes=CRSFforArduino.h From aa58e6e30921307646e97c194b89513b97634150 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:09:25 +1200 Subject: [PATCH 09/17] chore(ci): Rename `Build CRSF for Arduino` to `PlatformIO` This CI workflow builds CRSF for Arduino using PlatformIO. The name should reflect this. --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6091eef7..bb963e1d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,4 +1,4 @@ -name: Build CRSF for Arduino +name: PlatformIO on: [push] From 15e830d3668fff64148c3023e24711a92cedfcbd Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:10:54 +1200 Subject: [PATCH 10/17] chore(ci): Rename `Arduino Library CI` to `Arduino`. This CI workflow builds CRSF for Arduino using the Arduino IDE. The name should reflect this. --- .github/workflows/githubci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index 06abd264..4f64eb3a 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -1,4 +1,4 @@ -name: Arduino Library CI +name: Arduino on: [push] From 3fa7d8d43730add4524e4afb296ed8022522a9db Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:11:37 +1200 Subject: [PATCH 11/17] chore(ci): Remove commented out CI code. --- .github/workflows/githubci.yml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index 4f64eb3a..df64ca46 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -22,15 +22,5 @@ jobs: - name: Check for correct code formatting with clang-format run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r . -# Temporarily disable the check on documentation, as it is currently not needed at this time. -# - name: Check for correct documentation with doxygen -# env: -# GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }} -# PRETTYNAME : "CRSF for Arduino" -# run: bash ci/doxy_gen_and_deploy.sh - -# Temporarily disable testing on Metro M4, for now. -# For some reason, it is returning "No such file or directory" on CRSFforArduino.h -# Further investigation is needed. - name: Test the code on supported platforms run: python3 ci/build_platform.py metro_m4 From 15f6cdb97a361421cdbffbdb1a571b96ddbd405d Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:17:38 +1200 Subject: [PATCH 12/17] chore(ci): Rename `build.yml` to `platformio_build.yml` --- .github/workflows/{build.yml => platformio_build.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{build.yml => platformio_build.yml} (100%) diff --git a/.github/workflows/build.yml b/.github/workflows/platformio_build.yml similarity index 100% rename from .github/workflows/build.yml rename to .github/workflows/platformio_build.yml From b57c3d40c4753ed2fc25d906da0adb9147d4d7b9 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:18:15 +1200 Subject: [PATCH 13/17] chore(ci): Rename `githubci.yml` to `arduinoide_build.yml` --- .github/workflows/{githubci.yml => arduinoide_build.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{githubci.yml => arduinoide_build.yml} (100%) diff --git a/.github/workflows/githubci.yml b/.github/workflows/arduinoide_build.yml similarity index 100% rename from .github/workflows/githubci.yml rename to .github/workflows/arduinoide_build.yml From 9bf700cbb40efca38055bf9b90ab6bec690802eb Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:29:57 +1200 Subject: [PATCH 14/17] chore(readme): Update Arduino CI tag --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ff26e2d2..36239f2c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/ZZ-Cat/CRSFforArduino)](https://github.com/ZZ-Cat/CRSFforArduino/releases/latest) [![GitHub license](https://img.shields.io/github/license/ZZ-Cat/CRSFforArduino)](https://github.com/ZZ-Cat/CRSFforArduino/blob/Main-Trunk/LICENSE.md) -[![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/Arduino%20Library%20CI/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions) +[![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/Arduino/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions/arduinoide_build.yml) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) ## Written & developed by From e5fd158c9eec691e7a5a27cf97599494e0068c9f Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:30:35 +1200 Subject: [PATCH 15/17] chore(readme): Add PlatformIO CI tag --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 36239f2c..40e8c735 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/ZZ-Cat/CRSFforArduino)](https://github.com/ZZ-Cat/CRSFforArduino/releases/latest) [![GitHub license](https://img.shields.io/github/license/ZZ-Cat/CRSFforArduino)](https://github.com/ZZ-Cat/CRSFforArduino/blob/Main-Trunk/LICENSE.md) [![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/Arduino/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions/arduinoide_build.yml) +[![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/PlatformIO/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions/platformio_build.yml) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) ## Written & developed by From 7dff4ef645f934add05cd18fbb413bf90f1efcc4 Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:32:30 +1200 Subject: [PATCH 16/17] chore(readme): Move Conventional Commits tag Conventional Commits tag sits between the two CI tags & the Releases & License tags --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 40e8c735..59cb02fa 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/ZZ-Cat/CRSFforArduino)](https://github.com/ZZ-Cat/CRSFforArduino/releases/latest) [![GitHub license](https://img.shields.io/github/license/ZZ-Cat/CRSFforArduino)](https://github.com/ZZ-Cat/CRSFforArduino/blob/Main-Trunk/LICENSE.md) +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) [![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/Arduino/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions/arduinoide_build.yml) [![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/PlatformIO/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions/platformio_build.yml) -[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) ## Written & developed by From 0f0382c9fd605050275470975050abef4c57fdcc Mon Sep 17 00:00:00 2001 From: "Cassandra \"ZZ Cat\" Robinson" Date: Sat, 3 Jun 2023 13:37:47 +1200 Subject: [PATCH 17/17] chore(readme): Fix up Actions URL --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59cb02fa..db1cfd18 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/ZZ-Cat/CRSFforArduino)](https://github.com/ZZ-Cat/CRSFforArduino/releases/latest) [![GitHub license](https://img.shields.io/github/license/ZZ-Cat/CRSFforArduino)](https://github.com/ZZ-Cat/CRSFforArduino/blob/Main-Trunk/LICENSE.md) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) -[![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/Arduino/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions/arduinoide_build.yml) -[![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/PlatformIO/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions/platformio_build.yml) +[![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/Arduino/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions) +[![Build Status](https://github.com/ZZ-Cat/CRSFforArduino/workflows/PlatformIO/badge.svg)](https://github.com/ZZ-Cat/CRSFforArduino/actions) ## Written & developed by