Skip to content

Commit eb3d3b3

Browse files
committed
Update "smoke test" examples compilation CI workflow
On every push or pull request that affects library source or example files, and periodically, compile all example sketches for the specified boards.
1 parent ec24ccc commit eb3d3b3

File tree

2 files changed

+81
-19
lines changed

2 files changed

+81
-19
lines changed

.github/workflows/compile-examples.yml

Lines changed: 75 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,79 @@
11
name: Compile Examples
2-
on: [push, pull_request]
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
paths:
7+
- ".github/workflows/compile-examples.yml"
8+
- "examples/**"
9+
- "src/**"
10+
pull_request:
11+
paths:
12+
- ".github/workflows/compile-examples.yml"
13+
- "examples/**"
14+
- "src/**"
15+
schedule:
16+
# Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms).
17+
- cron: "0 8 * * TUE"
18+
workflow_dispatch:
19+
repository_dispatch:
20+
321
jobs:
4-
build:
5-
runs-on: ubuntu-latest
22+
build:
23+
name: ${{ matrix.board.fqbn }}
24+
runs-on: ubuntu-latest
25+
26+
strategy:
27+
fail-fast: false
28+
29+
matrix:
30+
board:
31+
- fqbn: arduino:samd:mkrzero
32+
platforms: |
33+
- name: arduino:samd
34+
- fqbn: arduino:samd:mkr1000
35+
platforms: |
36+
- name: arduino:samd
37+
- fqbn: arduino:samd:mkrwifi1010
38+
platforms: |
39+
- name: arduino:samd
40+
- fqbn: arduino:samd:mkrfox1200
41+
platforms: |
42+
- name: arduino:samd
43+
- fqbn: arduino:samd:mkrwan1300
44+
platforms: |
45+
- name: arduino:samd
46+
- fqbn: arduino:samd:mkrwan1310
47+
platforms: |
48+
- name: arduino:samd
49+
- fqbn: arduino:samd:mkrgsm1400
50+
platforms: |
51+
- name: arduino:samd
52+
- fqbn: arduino:samd:mkrnb1500
53+
platforms: |
54+
- name: arduino:samd
55+
- fqbn: arduino:samd:mkrvidor4000
56+
platforms: |
57+
- name: arduino:samd
58+
- fqbn: arduino:mbed_portenta:envie_m7
59+
platforms: |
60+
- name: arduino:mbed_portenta
61+
62+
steps:
63+
- name: Checkout repository
64+
uses: actions/checkout@v2
665

7-
strategy:
8-
matrix:
9-
fqbn: [
10-
"arduino:avr:uno",
11-
"arduino:samd:mkrzero"
12-
]
66+
- name: Compile examples
67+
uses: arduino/compile-sketches@v1
68+
with:
69+
github-token: ${{ secrets.GITHUB_TOKEN }}
70+
fqbn: ${{ matrix.board.fqbn }}
71+
platforms: ${{ matrix.board.platforms }}
72+
libraries: |
73+
# Install the library from the local path.
74+
- source-path: ./
75+
# Additional library dependencies can be listed here.
76+
# See: https://github.com/arduino/compile-sketches#libraries
77+
sketch-paths: |
78+
- examples
1379
14-
steps:
15-
- uses: actions/checkout@v1
16-
with:
17-
fetch-depth: 1
18-
- uses: arduino/actions/libraries/compile-examples@master
19-
with:
20-
fqbn: ${{ matrix.fqbn }}

README.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
= RS485 Library for Arduino =
1+
:repository-owner: arduino-libraries
2+
:repository-name: ArduinoRS485
23

3-
image:https://github.com/arduino-libraries/ArduinoRS485/workflows/Compile%20Examples/badge.svg["Compile Examples Status", link="https://github.com/arduino-libraries/ArduinoRS485/actions?workflow=Compile+Examples"] image:https://github.com/arduino-libraries/ArduinoRS485/workflows/Spell%20Check/badge.svg["Spell Check Status", link="https://github.com/arduino-libraries/ArduinoRS485/actions?workflow=Spell+Check"]
4+
= {repository-name} Library for Arduino =
5+
6+
image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"]
47

58
Enables sending and receiving data using the RS485 standard with RS485 shields, like the MKR 485 Shield.
69

710
This library supports the Maxim Integrated MAX3157 and equivalent chipsets.
811

912
For more information about this library please visit us at
10-
http://www.arduino.cc/en/Reference/ArduinoRS485
13+
http://www.arduino.cc/en/Reference/{repository-name}
1114

1215
== License ==
1316

0 commit comments

Comments
 (0)