Skip to content

Commit 0adf3e1

Browse files
aentingeraentinger
authored
Merge pull request #4 from arduino-libraries/ci
Use GitHub Actions for continuous integration
2 parents 95264d7 + d6d1efb commit 0adf3e1

File tree

12 files changed

+209
-23
lines changed

12 files changed

+209
-23
lines changed

‎.codespellrc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# See: https://github.com/codespell-project/codespell#using-a-config-file
2+
[codespell]
3+
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
4+
ignore-words-list = ,
5+
check-filenames =
6+
check-hidden =
7+
skip = ./.git,./src/cortex-m0plus,./src/touch_api_SAMD.h,./src/touch_config_samd.h,./src/touch.c

‎.github/dependabot.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file
2+
version: 2
3+
4+
updates:
5+
# Configure check for outdated GitHub Actions actions in workflows.
6+
# See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
7+
- package-ecosystem: github-actions
8+
directory: / # Check the repository's workflows under /.github/workflows/
9+
schedule:
10+
interval: daily

‎.github/workflows/check-arduino.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Check Arduino
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
pull_request:
7+
schedule:
8+
# Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
9+
- cron: "0 8 * * TUE"
10+
workflow_dispatch:
11+
repository_dispatch:
12+
13+
jobs:
14+
lint:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v2
20+
21+
- name: Arduino Lint
22+
uses: arduino/arduino-lint-action@v1
23+
with:
24+
compliance: specification
25+
library-manager: update
26+
# Always use this setting for official repositories. Remove for 3rd party projects.
27+
official: true
28+
project-type: library

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

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Compile Examples
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+
21+
jobs:
22+
build:
23+
name: ${{ matrix.board.fqbn }}
24+
runs-on: ubuntu-latest
25+
26+
env:
27+
SKETCHES_REPORTS_PATH: sketches-reports
28+
29+
strategy:
30+
fail-fast: false
31+
32+
matrix:
33+
board:
34+
- fqbn: arduino:samd:arduino_zero_edbg
35+
platforms: |
36+
- name: arduino:samd
37+
- fqbn: arduino:samd:mkrzero
38+
platforms: |
39+
- name: arduino:samd
40+
- fqbn: arduino:samd:mkr1000
41+
platforms: |
42+
- name: arduino:samd
43+
- fqbn: arduino:samd:mkrwifi1010
44+
platforms: |
45+
- name: arduino:samd
46+
- fqbn: arduino:samd:mkrfox1200
47+
platforms: |
48+
- name: arduino:samd
49+
- fqbn: arduino:samd:mkrwan1300
50+
platforms: |
51+
- name: arduino:samd
52+
- fqbn: arduino:samd:mkrwan1310
53+
platforms: |
54+
- name: arduino:samd
55+
- fqbn: arduino:samd:mkrgsm1400
56+
platforms: |
57+
- name: arduino:samd
58+
- fqbn: arduino:samd:mkrnb1500
59+
platforms: |
60+
- name: arduino:samd
61+
- fqbn: arduino:samd:mkrvidor4000
62+
platforms: |
63+
- name: arduino:samd
64+
- fqbn: arduino:samd:nano_33_iot
65+
platforms: |
66+
- name: arduino:samd
67+
68+
steps:
69+
- name: Checkout repository
70+
uses: actions/checkout@v2
71+
72+
- name: Compile examples
73+
uses: arduino/compile-sketches@v1
74+
with:
75+
github-token: ${{ secrets.GITHUB_TOKEN }}
76+
fqbn: ${{ matrix.board.fqbn }}
77+
platforms: ${{ matrix.board.platforms }}
78+
libraries: |
79+
# Install the library from the local path.
80+
- source-path: ./
81+
# Additional library dependencies can be listed here.
82+
# See: https://github.com/arduino/compile-sketches#libraries
83+
sketch-paths: |
84+
- examples
85+
enable-deltas-report: true
86+
sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
87+
88+
- name: Save sketches report as workflow artifact
89+
uses: actions/upload-artifact@v2
90+
with:
91+
if-no-files-found: error
92+
path: ${{ env.SKETCHES_REPORTS_PATH }}
93+
name: ${{ env.SKETCHES_REPORTS_PATH }}

‎.github/workflows/report-size-deltas.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Report Size Deltas
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/report-size-deltas.yml"
8+
schedule:
9+
# Run at the minimum interval allowed by GitHub Actions.
10+
# Note: GitHub Actions periodically has outages which result in workflow failures.
11+
# In this event, the workflows will start passing again once the service recovers.
12+
- cron: "*/5 * * * *"
13+
workflow_dispatch:
14+
repository_dispatch:
15+
16+
jobs:
17+
report:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Comment size deltas reports to PRs
21+
uses: arduino/report-size-deltas@v1
22+
with:
23+
# The name of the workflow artifact created by the sketch compilation workflow
24+
sketches-reports-source: sketches-reports

‎.github/workflows/spell-check.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Spell Check
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
pull_request:
7+
schedule:
8+
# Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
9+
- cron: "0 8 * * TUE"
10+
workflow_dispatch:
11+
repository_dispatch:
12+
13+
jobs:
14+
spellcheck:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v2
20+
21+
- name: Spell check
22+
uses: codespell-project/actions-codespell@master

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# MCHPTouch Library for Arduino
22

3+
[![Check Arduino status](https://github.com/arduino-libraries/Arduino_MCHPTouch/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_MCHPTouch/actions/workflows/check-arduino.yml)
4+
[![Compile Examples status](https://github.com/arduino-libraries/Arduino_MCHPTouch/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_MCHPTouch/actions/workflows/compile-examples.yml)
5+
[![Spell Check status](https://github.com/arduino-libraries/Arduino_MCHPTouch/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_MCHPTouch/actions/workflows/spell-check.yml)
6+
37
This library allows you to read touch sensors values from the [Arduino MKR](https://store.arduino.cc/arduino-mkr-wifi-1010) boards and the [Arduino Nano 33 IoT](https://store.arduino.cc/arduino-nano-33-iot). Touch sensing is a hardware capability of the SAMD21 processor.
48

59
```c++

‎examples/ReadSensors/ReadSensors.ino‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/*
2-
Arduino_MCHPTouch - Sensor data read Example
2+
Arduino_MCHPTouch - Sensor data read example
33
This example shows how to configure and read data
4-
from touch sensors bottons on MKR IoT Carrier and
4+
from touch sensor buttons on MKR IoT Carrier and
55
prints updates to the Serial Monitor.
66
77
The circuit:
8-
- Arduino MKR baord;
9-
- MKR IoT carrier.
8+
- Arduino MKR board
9+
- MKR IoT Carrier
1010
1111
This example code is in the public domain.
1212
*/
@@ -17,7 +17,7 @@ void setup()
1717
Serial.begin(9600);
1818
while (!Serial)
1919
;
20-
// Qtouch initialization
20+
// QTouch initialization
2121
if (!TOUCH.begin())
2222
{
2323
Serial.println("Error in sensors initialization!");
@@ -29,7 +29,7 @@ void setup()
2929

3030
void loop()
3131
{
32-
// polling the sensor for new measure
32+
// polling the sensor for new data
3333
TOUCH.poll();
3434

3535
// Checks if new data are available
@@ -49,4 +49,4 @@ void loop()
4949
Serial.println();
5050
}
5151
delay(100);
52-
}
52+
}

‎examples/setCustomSensitivity/setCustomSensitivity.ino‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
/*
2-
Arduino_MCHPTouch - Sensor data read Example
2+
Arduino_MCHPTouch - Sensor data read example
33
This example shows how to configure and read data
44
from touch sensor buttons on MKR IoT Carrier and
5-
65
prints updates to the Serial Monitor.
76
87
The circuit:
9-
- Arduino MKR board;
10-
11-
- MKR IoT carrier.
8+
- Arduino MKR board
9+
- MKR IoT Carrier
1210
1311
This example code is in the public domain.
1412
*/
@@ -19,10 +17,10 @@ void setup()
1917
Serial.begin(9600);
2018
while (!Serial)
2119
;
22-
//Set custom sens on X channel
20+
//Set custom sensitivity on X channel
2321
//TOUCH.setSensorsSensitivity(*newSensitivity*, channel);
2422
TOUCH.setSensorsSensitivity(98, 0);
25-
// Qtouch initialization
23+
// QTouch initialization
2624
if (!TOUCH.begin())
2725
{
2826
Serial.println("Error in sensors initialization!");

‎keywords.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#######################################
2-
# Syntax Coloring Map For MCHPTouch
2+
# Syntax Coloring Map For Arduino_MCHPTouch
33
#######################################
44

55
#######################################

0 commit comments

Comments
 (0)