Merge pull request #299 from per1234/github-actions

Use GitHub Actions for CI

Author: aentinger

.github/workflows/compile-examples.yml

@@ -0,0 +1,91 @@
+name: Compile Examples
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/compile-examples.yml"
+      - "examples/**"
+      - "src/**"
+  push:
+    paths:
+      - ".github/workflows/compile-examples.yml"
+      - "examples/**"
+      - "src/**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    env:
+      # sketch paths to compile (recursive) for all boards
+      UNIVERSAL_SKETCH_PATHS: |
+        - examples/AP_SimpleWebServer
+        - examples/CheckWifi101FirmwareVersion
+        - examples/ConnectNoEncryption
+        - examples/ConnectWithWEP
+        - examples/ConnectWithWPA
+        - examples/MDNS_WiFiWebServer
+        - examples/Provisioning_WiFiWebServer
+        - examples/ScanNetworks
+        - examples/ScanNetworksAdvanced
+        - examples/SimpleWebServerWiFi
+        - examples/WiFiChatServer
+        - examples/WiFiPing
+        - examples/WiFiSSLClient
+        - examples/WiFiUdpNtpClient
+        - examples/WiFiUdpSendReceiveString
+        - examples/WiFiWebClient
+        - examples/WiFiWebClientRepeating
+        - examples/WiFiWebServer
+      SKETCHES_REPORTS_PATH: sketches-reports
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        board:
+          - fqbn: arduino:avr:uno
+            firmwareUpdaterSupport: false
+          - fqbn: arduino:avr:mega
+            firmwareUpdaterSupport: false
+          - fqbn: arduino:sam:arduino_due_x_dbg
+            firmwareUpdaterSupport: true
+          - fqbn: arduino:samd:arduino_zero_edbg
+            firmwareUpdaterSupport: true
+          - fqbn: arduino:samd:mkr1000
+            firmwareUpdaterSupport: true
+          - fqbn: Intel:arc32:arduino_101
+            firmwareUpdaterSupport: true
+
+        # make board type-specific customizations to the matrix jobs
+        include:
+          - board:
+              firmwareUpdaterSupport: true
+            firmwareUpdater-sketch-paths: |
+              - examples/FirmwareUpdater
+          - board:
+              firmwareUpdaterSupport: false
+            firmwareUpdater-sketch-paths: ""
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Compile examples
+        uses: arduino/compile-sketches@main
+        with:
+          fqbn: ${{ matrix.board.fqbn }}
+          libraries: |
+            # Install the WiFi101 library from the local path
+            - source-path: ./
+          sketch-paths: |
+            ${{ env.UNIVERSAL_SKETCH_PATHS }}
+            ${{ matrix.firmwareUpdater-sketch-paths }}
+          enable-deltas-report: true
+          sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
+
+      - name: Save memory usage change report as artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ env.SKETCHES_REPORTS_PATH }}
+          path: ${{ env.SKETCHES_REPORTS_PATH }}

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

@@ -0,0 +1,14 @@
+on:
+  schedule:
+    - cron:  '*/5 * * * *'
+
+jobs:
+  report:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Comment size deltas reports to PRs
+        uses: arduino/report-size-deltas@main
+        with:
+          # The name of the workflow artifact created by the "Compile Examples" workflow
+          sketches-reports-source: sketches-reports

.github/workflows/spell-check.yml

@@ -0,0 +1,26 @@
+name: Spell Check
+
+on:
+  pull_request:
+  push:
+  schedule:
+    # run every Tuesday at 3 AM UTC
+    - cron: "0 3 * * 2"
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
+      - name: Spell check
+        uses: codespell-project/actions-codespell@master
+        with:
+          check_filenames: true
+          check_hidden: true
+          # In the event of a false positive, add the word in all lower case to this file:
+          ignore_words_file: extras/codespell-ignore-words-list.txt
+          skip: ./.git,./src/bsp,./src/bus_wrapper,./src/common,./src/driver,./src/socket,./src/spi_flash

.travis.yml

@@ -3,15 +3,15 @@ WiFi101 ?.?.? - ????.??.??
 WiFi101 0.16.0 - 2018.04.04
 
 * Added WiFi.setTimeout(timeout) API to set timeout of WiFi.begin(...)
-* Changed check firmware version comparision from == to >=
+* Changed check firmware version comparison from == to >=
 * Updated latest firmware version for model B to 19.6.1
 
 WiFi101 0.15.3 - 2018.11.21
 
 * Fixed unreachable destination issue in UDP packet transmission
-* Changed where required, in library's examples, the server's URL arduino.cc\80 in example.org\80, because http://arduino.cc will be no longer available
-* Changed the MAC address print in the library's example now are showed corectly all the MAC address chars
-* Fixed WiFiUDP::endPacket() return value in accord with sendig returns. Thanks to @mjlitke @jrowberg
+* Changed where required, in library's examples, the server's URL arduino.cc\80 to example.org\80, because http://arduino.cc will be no longer available
+* Changed the MAC address print in the library's example now are showed correctly all the MAC address chars
+* Fixed WiFiUDP::endPacket() return value in accord with sending returns. Thanks to @mjlitke @jrowberg
 * Changed WiFiSocketClass::create(...) return condition. Thanks to @jrowberg
 * Changed server and URL to avoid 301 response from Server
 * Fixed initialization Server issue by adding socket initialization in WiFiServer::WiFiServer constructor
@@ -45,7 +45,7 @@ WiFi101 0.14.2 - 2017.05.08
 WiFi101 0.14.1 - 2017.04.20
 
 * Fixed issues with WiFiMDNSResponder and Windows using Bonjour
-* Correct cast of buffer size when processing received data 
+* Correct cast of buffer size when processing received data
 
 WiFi101 0.14.0 - 2017.03.22
 
@@ -69,7 +69,7 @@ WiFi101 0.12.0 - 2017.01.05
 * Fixed WiFi.getTime() not returning 0, if time has not been synced via NTP
 * Fixed crashing when connecting after scanning
 * Fixed WiFiServer::available() returning valid client on outbound client connection
-* Added WiFiUdp::beginMulticast(port) function for compatiblity with EthernetUdp, as beginMulti was inconsistent
+* Added WiFiUdp::beginMulticast(port) function for compatibility with EthernetUdp, as beginMulti was inconsistent
 
 WiFi101 0.11.2 - 2016.12.15
 
@@ -93,7 +93,7 @@ WiFi101 0.10.0 - 2016.09.08
 
 * Added WiFi.end() to disconnect from the AP or end AP mode
 * Added new WiFi.ping(...) functionality. Thanks @PKGeorgiev
-* Added WiFi.setPins(...) to customize the CS, INTN, RESET and CHIPEN pins 
+* Added WiFi.setPins(...) to customize the CS, INTN, RESET and CHIPEN pins
 * Add new WL_AP_LISTENING, WL_AP_CONNECTED, and WL_AP_FAILED status types for AP mode
 * Fixed return value of WiFiUDP::beginPacket(host, port) when host is successfully resolved
 * Added power management methods: WiFi.lowPowerMode(), WiFi.maxLowPowerMode(), WiFi.noLowPowerMode()
@@ -128,7 +128,7 @@ WiFi101 0.8.0 - 2016.02.15
 WiFi101 0.7.0 - 2015.01.11
 
 * Added support for WiFi Firmware 19.4.4
-* WiFi.hostByName(...) will not try resolve the domain name if it's already a numeric IP
+* WiFi.hostByName(...) will not try to resolve the domain name if it's already a numeric IP
 * Fixed manual IP configuration (no DHCP)
 * Fixed WiFiServer.available(), now follows API specification
 * Fixed WEP key connection
@@ -140,7 +140,7 @@ WiFi101 0.6.0 - 2015.11.27
 
 * Fixed bug with AVR boards when Web Server is used
 * Fixed UDP read bug on AVR Boards
-* Added missing inlcude for SSL Client
+* Added missing include for SSL Client
 * Fixed peek() function
 * Fixed some examples
 

CHANGELOG

@@ -1,12 +1,17 @@
-= WiFi library for the Arduino WiFi Shield 101 and MKR1000 board =
+// Define the repository information in these attributes
+:repository-owner: arduino-libraries
+:repository-name: WiFi101
 
-image:https://travis-ci.org/arduino-libraries/WiFi101.svg?branch=master["Build Status", link="https://travis-ci.org/arduino-libraries/WiFi101"]
+= {repository-name} library for for the Arduino WiFi Shield 101 and MKR1000 board =
+
+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"]
+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"]
 
 This library implements a network driver for devices based
 on the ATMEL WINC1500 WiFi module.
 
 For more information about this library please visit us at
-https://www.arduino.cc/en/Reference/WiFi101
+https://www.arduino.cc/en/Reference/{repository-name}
 
 == License ==
 

README.adoc

@@ -41,7 +41,7 @@ void setup() {
 
   // check for the presence of the shield:
   if (WiFi.status() == WL_NO_SHIELD) {
-    Serial.println("WiFi shield not present");
+    Serial.println("WiFi 101 Shield not present");
     // don't continue
     while (true);
   }
@@ -54,7 +54,7 @@ void setup() {
   Serial.print("Creating access point named: ");
   Serial.println(ssid);
 
-  // Create open network. Change this line if you want to create an WEP network:
+  // Create open network. Change this line if you want to create a WEP network:
   status = WiFi.beginAP(ssid);
   if (status != WL_AP_LISTENING) {
     Serial.println("Creating access point failed");
@@ -76,7 +76,7 @@ void setup() {
 void loop() {
   // compare the previous status to the current status
   if (status != WiFi.status()) {
-    // it has changed update the variable
+    // it has changed, so update the variable
     status = WiFi.status();
 
     if (status == WL_AP_CONNECTED) {
@@ -98,7 +98,7 @@ void loop() {
     Serial.println("new client");           // print a message out the serial port
     String currentLine = "";                // make a String to hold incoming data from the client
     while (client.connected()) {            // loop while the client's connected
-      if (client.available()) {             // if there's bytes to read from the client,
+      if (client.available()) {             // if there are bytes to read from the client,
         char c = client.read();             // read a byte, then
         Serial.write(c);                    // print it out the serial monitor
         if (c == '\n') {                    // if the byte is a newline character
@@ -149,7 +149,7 @@ void printWiFiStatus() {
   Serial.print("SSID: ");
   Serial.println(WiFi.SSID());
 
-  // print your WiFi shield's IP address:
+  // print your WiFi 101 Shield's IP address:
   IPAddress ip = WiFi.localIP();
   Serial.print("IP Address: ");
   Serial.println(ip);

examples/AP_SimpleWebServer/AP_SimpleWebServer.ino

@@ -1,3 +1,2 @@
 #define SECRET_SSID ""
 #define SECRET_PASS ""
-

examples/AP_SimpleWebServer/arduino_secrets.h

@@ -1,9 +1,9 @@
 /*
- * This example check if the firmware loaded on the WiFi101
+ * This example checks if the firmware loaded on the WiFi101
  * shield is updated.
  *
  * Circuit:
- * - WiFi101 Shield attached
+ * - WiFi 101 Shield attached
  *
  * Created 29 July 2015 by Cristian Maglie
  * This code is in the public domain.
@@ -24,7 +24,7 @@ void setup() {
   Serial.println();
 
   // Check for the presence of the shield
-  Serial.print("WiFi101 shield: ");
+  Serial.print("WiFi 101 Shield: ");
   if (WiFi.status() == WL_NO_SHIELD) {
     Serial.println("NOT PRESENT");
     return; // don't continue
@@ -55,7 +55,7 @@ void setup() {
     Serial.println("Check result: PASSED");
   } else {
     Serial.println("Check result: NOT PASSED");
-    Serial.println(" - The firmware version on the shield do not match the");
+    Serial.println(" - The firmware version on the shield does not match the");
     Serial.println("   version required by the library, you may experience");
     Serial.println("   issues or failures.");
   }
@@ -64,4 +64,3 @@ void setup() {
 void loop() {
   // do nothing
 }
-

examples/CheckWifi101FirmwareVersion/CheckWifi101FirmwareVersion.ino

@@ -1,11 +1,11 @@
 /*
 
  This example connects to an unencrypted WiFi network.
- Then it prints the  MAC address of the WiFi shield,
+ Then it prints the MAC address of the WiFi 101 Shield,
  the IP address obtained, and other network details.
 
  Circuit:
- * WiFi shield attached
+ * WiFi 101 Shield attached
 
  created 13 July 2010
  by dlf (Metodo2 srl)
@@ -28,7 +28,7 @@ void setup() {
 
   // check for the presence of the shield:
   if (WiFi.status() == WL_NO_SHIELD) {
-    Serial.println("WiFi shield not present");
+    Serial.println("WiFi 101 Shield not present");
     // don't continue:
     while (true);
   }
@@ -56,7 +56,7 @@ void loop() {
 }
 
 void printWiFiData() {
-  // print your WiFi shield's IP address:
+  // print your WiFi 101 Shield's IP address:
   IPAddress ip = WiFi.localIP();
   Serial.print("IP Address: ");
   Serial.println(ip);