Add CI workflows #81

giulcioffi · 2020-09-07T17:03:32Z

The compile-examples workflow compiles:

internal core libraries + examples
some of the most used libraries + related examples
all the basic examples provided in the Arduino IDE which are compatible with the boards that use this core
Memory usage information collection is always enabled and handled by the report-size-deltas workflow.

With the current version of the core, the compilation of the following libraries examples will fail:

~/Arduino/libraries/MFRC522/examples
~/Arduino/libraries/Adafruit_MQTT_Library/examples/mqtt_ethernet
Their failure is due to issue F() Flash Macro No Longer Recognized #62 . Once the F macro will be fixed, the compilation of these examples will be successful.

…t as artifact' step

per1234 · 2020-09-08T01:41:58Z

.github/workflows/compile-examples.yml

@@ -0,0 +1,117 @@
+name: Compile Examples
+
+on: [pull_request, push]


Suggested change

on: [pull_request, push]

on:

pull_request:

paths:

- ".github/workflows/compile-examples.yml"

- "cores/**"

- "libraries/**"

- "variants/**"

- "boards.txt"

- "platform.txt"

push:

paths:

- ".github/workflows/compile-examples.yml"

- "cores/**"

- "libraries/**"

- "variants/**"

- "boards.txt"

- "platform.txt"

This causes the workflow to only run when a file relevant to sketch compilation, or the workflow itself, is modified:
https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths

per1234 · 2020-09-08T01:44:03Z

.github/workflows/compile-examples.yml

+      # libraries to install for all boards
+      UNIVERSAL_LIBRARIES: '"MFRC522" "Servo" "LiquidCrystal"'


Suggested change

# libraries to install for all boards

UNIVERSAL_LIBRARIES: '"MFRC522" "Servo" "LiquidCrystal"'

This environment variable is unused and these libraries are defined in the arduino/actions/libraries/compile-examples action's libraries input. So this can be removed to avoid confusion.

per1234 · 2020-09-08T01:53:08Z

.github/workflows/compile-examples.yml

+        - ~/Arduino/libraries/Servo/examples
+        - ~/Arduino/libraries/LiquidCrystal/examples
+        - ~/Arduino/libraries/MFRC522/examples
+        - ~/Arduino/libraries/Ethernet/examples
+        - ~/Arduino/libraries/Arduino_LSM9DS1/examples
+        - ~/Arduino/libraries/SD/examples
+        - ~/Arduino/libraries/Arduino_JSON/examples
+        - ~/Arduino/libraries/WiFi/examples


From what I can tell, some of the libraries listed in the arduino/actions/libraries/compile-examples action's libraries input are not being used for anything because they aren't in this list and they aren't dependencies of anything in this list.

One option would be to just use the root of the libraries folder as the sketch path:

- ~/Arduino/libraries

The only problem with that is that maybe you have library dependencies of libraries or sketches installed there and you don't want to compile the examples of those libraries.

per1234 · 2020-09-08T02:02:29Z

.github/workflows/compile-examples.yml

+        board: [
+          {"fqbn": "arduino:megaavr:uno2018", "type": "unoWiFiRev2"},
+          {"fqbn": "arduino:megaavr:nona4809", "type": "nanoEvery"}
+        ]


Suggested change

board: [

{"fqbn": "arduino:megaavr:uno2018", "type": "unoWiFiRev2"},

{"fqbn": "arduino:megaavr:nona4809", "type": "nanoEvery"}

]

fqbn:

- "arduino:megaavr:uno2018:mode=on"

- "arduino:megaavr:uno2018:mode=off"

- "arduino:megaavr:nona4809"

A few suggestions combined here:

The type keys were not being used, so I removed them.

I find the YAML-style list format to be easier to understand in the context of the style of the rest of the document.

Test the `"Registers emulation" board option.

per1234 · 2020-09-08T02:03:07Z

.github/workflows/compile-examples.yml

+      - name: Checkout Adafruit WiFiNINA
+        uses: actions/checkout@v2
+        with:
+          repository: adafruit/WiFiNINA
+          path: adafruit/WiFiNINA


What is the reason for this?

per1234 · 2020-09-08T02:06:40Z

.github/workflows/compile-examples.yml

+          path: extras
+
+      - name: Delete incompatible examples
+        run: rm -r "$GITHUB_WORKSPACE/extras/examples/09.USB" && rm -r "$GITHUB_WORKSPACE/extras/examples/10.StarterKit_BasicKit/p11_CrystalBall" && rm -r "$GITHUB_WORKSPACE/extras/examples/10.StarterKit_BasicKit/p13_TouchSensorLamp"


Suggested change

run: rm -r "$GITHUB_WORKSPACE/extras/examples/09.USB" && rm -r "$GITHUB_WORKSPACE/extras/examples/10.StarterKit_BasicKit/p11_CrystalBall" && rm -r "$GITHUB_WORKSPACE/extras/examples/10.StarterKit_BasicKit/p13_TouchSensorLamp"

run: |

rm -r "$GITHUB_WORKSPACE/extras/examples/09.USB"

rm -r "$GITHUB_WORKSPACE/extras/examples/10.StarterKit_BasicKit/p11_CrystalBall"

rm -r "$GITHUB_WORKSPACE/extras/examples/10.StarterKit_BasicKit/p13_TouchSensorLamp"

I think this is a little easier to read and maintain. The GitHub Actions shell runs in errexit exit mode, so there is no functional difference.

I do have a question about the removal of the p11_CrystalBall example. This isn't really incompatible, is it? I know it was failing to compile due to a bug (arduino/Arduino#10025), but that bug has already been fixed (arduino/ArduinoCore-API@7f8de58). I just gave it a try with my Uno WiFi Rev2 and the updated ArduinoCore-API and it works fine for me.

I also have a suggestion about the p13_TouchSensorLamp sketch. I'm guessing in this case it's not about a fundamental incompatibility (such as the hardware incompatibility with the USB examples), but simply that nobody has gotten around to adding support for megaAVR to the CapacitiveSensor library. If so, I would recommend adding a comment to that effect (ideally referencing an issue used to track any progress on adding compatibility). That way, it will be clear that the line removing that example can be removed once the library finally does become compatible. This new one command per line format facilitates adding comments.

per1234 · 2020-09-08T02:07:40Z

.github/workflows/compile-examples.yml

+      - name: Compile examples
+        uses: arduino/actions/libraries/compile-examples@master
+        with:
+          fqbn: ${{ matrix.board.fqbn }}


Suggested change

fqbn: ${{ matrix.board.fqbn }}

fqbn: ${{ matrix.fqbn }}

This goes along with my matrix restructuring suggestion above.

per1234 · 2020-09-08T02:15:48Z

.github/workflows/compile-examples.yml

+            - name: Arduino_JSON
+            - name: Arduino_HTS221
+            - name: Firmata
+            - name: ArduinoCloudThing


Suggested change

- name: ArduinoCloudThing

This library is obsolete.

per1234 · 2020-09-08T02:30:10Z

.github/workflows/compile-examples.yml

+            - name: ArduinoDMX
+            - name: ArduinoRS485
+            - name: Arduino_OAuth
+            - name: WiFi


The WiFi library is for use with the long retired Arduino WiFi Shield, which is probably not used by anyone any more. So I'm not sure it's worth testing the megaAVR boards platform against it.

On the other hand, I would suggest testing the WiFiNINA library's examples, which is not currently done by this workflow.

per1234 · 2020-09-08T02:43:40Z

.github/workflows/compile-examples.yml

+            - name: Bridge
+            - name: Temboo


I'm uncertain about the value of testing against these.

I'm sure you could put a Yun shield on an Uno WiFi Rev2, in which case the Bridge library would be needed, but it doesn't seem like it would be a common use case.

Although It should be possible to use the Temboo library with the WiFiNINA library (though you won't find any information about this anywhere in the Temboo documentation or wizards), the Temboo library example sketches are all written for the Yun.

aentinger · 2020-09-10T04:48:51Z

Hi @giulcioffi and @per1234 👋 Thank you @giulcioffi for creating this PR as well as @per1234 for doing a in-detail review. May I ask you to stick your heads together to finish this PR up so we can merge it?

…evant to sketch compilation

per1234

Great work @giulcioffi. I'm really excited for this being added to the ArduinoCore-megaavr repository!

giulcioffi added 12 commits September 7, 2020 18:51

Add workflow for CI

7e4c423

FONAtest search path

48cdeda

Install latest version of libraries

b2ea934

Remove 'size-report-sketch' entry and 'Save memory usage change repor…

c654b79

…t as artifact' step

Add board target Arduino Nano Every

9497c8c

Add step to download basic examples + add UNIVERSAL paths

cfd3a8d

Add step to remove incompatible basic examples

ce359ad

Add most used libraries + examples

d68d967

Add step to save memory usage change

95445d2

Remove board type specific customization

9f728df

Remove condition to execute report artifact only with a PR

39e1395

Use list format also for sketch paths

fb15914

giulcioffi requested review from cmaglie and aentinger September 7, 2020 17:03

giulcioffi mentioned this pull request Sep 7, 2020

Fix F macro definition #82

Closed

per1234 suggested changes Sep 8, 2020

View reviewed changes

giulcioffi added 7 commits September 10, 2020 12:19

Run workflow only after modification of the workflow or of a file rel…

72cd7c0

…evant to sketch compilation

Remove not necessary libraries and variables

945db37

Split remove commands + add comments

964531a

Compile WiFiNINA library

c9587a2

Reinsert types to compile WiFiNINA examples only for Uno WiFi Rev2

a18eccc

Try to compile all the libraries examples

283703a

Remove incompatible examples

0eb5c64

per1234 approved these changes Sep 10, 2020

View reviewed changes

aentinger merged commit 9e6b35b into arduino:master Sep 10, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CI workflows #81

Add CI workflows #81

giulcioffi commented Sep 7, 2020 •

edited

Loading

per1234 Sep 8, 2020

per1234 Sep 8, 2020

per1234 Sep 8, 2020

per1234 Sep 8, 2020

per1234 Sep 8, 2020

per1234 Sep 8, 2020 •

edited

Loading

per1234 Sep 8, 2020

per1234 Sep 8, 2020

per1234 Sep 8, 2020

per1234 Sep 8, 2020

aentinger commented Sep 10, 2020

per1234 left a comment

		@@ -0,0 +1,117 @@
		name: Compile Examples

		on: [pull_request, push]

-on: [pull_request, push]
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/compile-examples.yml"
+      - "cores/**"
+      - "libraries/**"
+      - "variants/**"
+      - "boards.txt"
+      - "platform.txt"
+  push:
+    paths:
+      - ".github/workflows/compile-examples.yml"
+      - "cores/**"
+      - "libraries/**"
+      - "variants/**"
+      - "boards.txt"
+      - "platform.txt"

		# libraries to install for all boards
		UNIVERSAL_LIBRARIES: '"MFRC522" "Servo" "LiquidCrystal"'

Add CI workflows #81

Add CI workflows #81

Conversation

giulcioffi commented Sep 7, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

per1234 Sep 8, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aentinger commented Sep 10, 2020

per1234 left a comment

Choose a reason for hiding this comment

giulcioffi commented Sep 7, 2020 •

edited

Loading

per1234 Sep 8, 2020 •

edited

Loading