Skip to content

Commit 08f534e

Browse files
aentingeraentinger
authored
Merge pull request #151 from per1234/github-actions
Use GitHub Actions for continuous integration
2 parents 7a85845 + 8169895 commit 08f534e

File tree

33 files changed

+199
-165
lines changed

33 files changed

+199
-165
lines changed

‎.codespellrc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[codespell]
2+
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
3+
ignore-words-list = endianess
4+
check-filenames =
5+
check-hidden =
6+
skip = ./.git

‎.github/workflows/compile-examples.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Compile Examples
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- ".github/workflows/compile-examples.yml"
7+
- "examples/**"
8+
- "src/**"
9+
push:
10+
paths:
11+
- ".github/workflows/compile-examples.yml"
12+
- "examples/**"
13+
- "src/**"
14+
# Scheduled trigger checks for breakage caused by changes to external resources (libraries, platforms)
15+
schedule:
16+
# run every Saturday at 3 AM UTC
17+
- cron: "0 3 * * 6"
18+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch
19+
workflow_dispatch:
20+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch
21+
repository_dispatch:
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
27+
env:
28+
SKETCHES_REPORTS_PATH: sketches-reports
29+
30+
strategy:
31+
fail-fast: false
32+
33+
matrix:
34+
board:
35+
- fqbn: arduino:samd:mkrwifi1010
36+
- fqbn: arduino:samd:mkrvidor4000
37+
- fqbn: arduino:megaavr:uno2018:mode=on
38+
39+
steps:
40+
- name: Checkout
41+
uses: actions/checkout@v2
42+
43+
- name: Compile examples
44+
uses: arduino/compile-sketches@main
45+
with:
46+
fqbn: ${{ matrix.board.fqbn }}
47+
libraries: |
48+
# Install the library from the local path.
49+
- source-path: ./
50+
# Install library dependencies.
51+
- name: VidorPeripherals
52+
sketch-paths: |
53+
- ./examples/
54+
enable-deltas-report: true
55+
sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
56+
57+
- name: Save memory usage change report as artifact
58+
uses: actions/upload-artifact@v2
59+
with:
60+
name: ${{ env.SKETCHES_REPORTS_PATH }}
61+
path: ${{ env.SKETCHES_REPORTS_PATH }}

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Report Size Deltas
2+
3+
on:
4+
schedule:
5+
- cron: '*/5 * * * *'
6+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch
7+
workflow_dispatch:
8+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch
9+
repository_dispatch:
10+
11+
jobs:
12+
report:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
# See: https://github.com/arduino/actions/blob/master/libraries/report-size-deltas/README.md
17+
- name: Comment size deltas reports to PRs
18+
uses: arduino/report-size-deltas@main
19+
with:
20+
# The name of the workflow artifact created by the "Compile Examples" workflow
21+
sketches-reports-source: sketches-reports

‎.github/workflows/spell-check.yml

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

‎.travis.yml

Lines changed: 0 additions & 48 deletions
This file was deleted.

‎README.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
= WiFiNINA Library for Arduino =
1+
// Define the repository information in these attributes
2+
:repository-owner: arduino-libraries
3+
:repository-name: WiFiNINA
24

3-
image:https://travis-ci.org/arduino-libraries/WiFiNINA.svg?branch=master["Build Status", link="https://travis-ci.org/arduino-libraries/WiFiNINA"]
5+
= {repository-name} library for Arduino =
6+
7+
image:https://github.com/{repository-owner}/{repository-name}/workflows/Compile%20Examples/badge.svg["Compile Examples Status", link="https://github.com/{repository-owner}/{repository-name}/actions?workflow=Compile+Examples"]
8+
image:https://github.com/{repository-owner}/{repository-name}/workflows/Spell%20Check/badge.svg["Spell Check Status", link="https://github.com/{repository-owner}/{repository-name}/actions?workflow=Spell+Check"]
49

510
Enables network connection (local and Internet) with the Arduino MKR WiFi 1010, Arduino MKR VIDOR 4000 and Arduino UNO WiFi Rev.2.
611

712
With this library you can instantiate Servers, Clients and send/receive UDP packets through WiFi. The board can connect either to open or encrypted networks (WEP, WPA). The IP address can be assigned statically or through a DHCP. The library can also manage DNS.
813

914
For more information about this library please visit us at
10-
http://www.arduino.cc/en/Reference/WiFiNINA
15+
https://www.arduino.cc/en/Reference/{repository-name}
1116

1217
== License ==
1318

‎examples/AP_SimpleWebServer/AP_SimpleWebServer.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
A simple web server that lets you blink an LED via the web.
55
This sketch will create a new access point (with no password).
66
It will then launch a new server and print out the IP address
7-
to the Serial monitor. From there, you can open that address in a web browser
7+
to the Serial Monitor. From there, you can open that address in a web browser
88
to turn on and off the LED on pin 13.
99
1010
If the IP address of your board is yourAddress:
@@ -22,7 +22,7 @@
2222
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
2323
char ssid[] = SECRET_SSID; // your network SSID (name)
2424
char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP)
25-
int keyIndex = 0; // your network key Index number (needed only for WEP)
25+
int keyIndex = 0; // your network key index number (needed only for WEP)
2626

2727
int led = LED_BUILTIN;
2828
int status = WL_IDLE_STATUS;
@@ -51,7 +51,7 @@ void setup() {
5151
Serial.println("Please upgrade the firmware");
5252
}
5353

54-
// by default the local IP address of will be 192.168.4.1
54+
// by default the local IP address will be 192.168.4.1
5555
// you can override it with the following:
5656
// WiFi.config(IPAddress(10, 0, 0, 1));
5757

‎examples/ConnectNoEncryption/ConnectNoEncryption.ino

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
/*
2-
3-
This example connects to an unencrypted Wifi network.
2+
This example connects to an unencrypted WiFi network.
43
Then it prints the MAC address of the board,
54
the IP address obtained, and other network details.
65
@@ -15,7 +14,7 @@
1514
#include "arduino_secrets.h"
1615
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
1716
char ssid[] = SECRET_SSID; // your network SSID (name)
18-
int status = WL_IDLE_STATUS; // the Wifi radio's status
17+
int status = WL_IDLE_STATUS; // the WiFi radio's status
1918

2019
void setup() {
2120
//Initialize serial and wait for port to open:
@@ -35,7 +34,7 @@ void setup() {
3534
Serial.println("Please upgrade the firmware");
3635
}
3736

38-
// attempt to connect to Wifi network:
37+
// attempt to connect to WiFi network:
3938
while (status != WL_CONNECTED) {
4039
Serial.print("Attempting to connect to open SSID: ");
4140
Serial.println(ssid);

‎examples/ConnectWithWEP/ConnectWithWEP.ino

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
3-
This example connects to a WEP-encrypted Wifi network.
4-
Then it prints the MAC address of the Wifi module,
2+
This example connects to a WEP-encrypted WiFi network.
3+
Then it prints the MAC address of the WiFi module,
54
the IP address obtained, and other network details.
65
76
If you use 40-bit WEP, you need a key that is 10 characters long,
@@ -26,8 +25,8 @@
2625
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
2726
char ssid[] = SECRET_SSID; // your network SSID (name)
2827
char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP)
29-
int keyIndex = 0; // your network key Index number
30-
int status = WL_IDLE_STATUS; // the Wifi radio's status
28+
int keyIndex = 0; // your network key index number
29+
int status = WL_IDLE_STATUS; // the WiFi radio's status
3130

3231
void setup() {
3332
//Initialize serial and wait for port to open:
@@ -48,7 +47,7 @@ void setup() {
4847
Serial.println("Please upgrade the firmware");
4948
}
5049

51-
// attempt to connect to Wifi network:
50+
// attempt to connect to WiFi network:
5251
while (status != WL_CONNECTED) {
5352
Serial.print("Attempting to connect to WEP network, SSID: ");
5453
Serial.println(ssid);

‎examples/ConnectWithWPA/ConnectWithWPA.ino

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
3-
This example connects to an unencrypted Wifi network.
4-
Then it prints the MAC address of the Wifi module,
2+
This example connects to an unencrypted WiFi network.
3+
Then it prints the MAC address of the WiFi module,
54
the IP address obtained, and other network details.
65
76
created 13 July 2010
@@ -16,7 +15,7 @@
1615
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
1716
char ssid[] = SECRET_SSID; // your network SSID (name)
1817
char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP)
19-
int status = WL_IDLE_STATUS; // the Wifi radio's status
18+
int status = WL_IDLE_STATUS; // the WiFi radio's status
2019

2120
void setup() {
2221
//Initialize serial and wait for port to open:
@@ -37,7 +36,7 @@ void setup() {
3736
Serial.println("Please upgrade the firmware");
3837
}
3938

40-
// attempt to connect to Wifi network:
39+
// attempt to connect to WiFi network:
4140
while (status != WL_CONNECTED) {
4241
Serial.print("Attempting to connect to WPA SSID: ");
4342
Serial.println(ssid);

0 commit comments

Comments
 (0)