Merge pull request #4 from arduino-libraries/ci

[CI] Add more workflows

Author: manchoz

.codespellrc

@@ -0,0 +1,8 @@
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = compiletime,
+builtin = clear,informal,en-GB_to_en-US
+check-filenames =
+check-hidden =
+skip = ./.git,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock,*.jdebug

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# See: https://docs.github.com/en/code-security/supply-chain-security/configuration-options-for-dependency-updates#about-the-dependabotyml-file
+version: 2
+
+updates:
+  # Configure check for outdated GitHub Actions actions in workflows.
+  # See: https://docs.github.com/en/code-security/supply-chain-security/keeping-your-actions-up-to-date-with-dependabot
+  - package-ecosystem: github-actions
+    directory: / # Check the repository's workflows under /.github/workflows/
+    schedule:
+      interval: daily
+    labels:
+      - "topic: infrastructure"

.github/workflows/check-arduino.yml

@@ -0,0 +1,30 @@
+# Source: https://github.com/arduino/.github/blob/master/workflow-templates/check-arduino.md
+name: Check Arduino
+
+# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
+on:
+  push:
+  pull_request:
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Arduino Lint
+        uses: arduino/arduino-lint-action@v1
+        with:
+          compliance: specification
+          # TODO: This is only needed for standalone libraries.
+          # Change this to "update" once the library is added to the index.
+          library-manager: update
+          # Always use this setting for official repositories. Remove for 3rd party projects.
+          official: true

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

@@ -0,0 +1,25 @@
+# Source: https://github.com/arduino/.github/blob/master/workflow-templates/report-size-deltas.md
+name: Report Size Deltas
+
+# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
+on:
+  push:
+    paths:
+      - ".github/workflows/report-size-deltas.ya?ml"
+  schedule:
+    # Run at the minimum interval allowed by GitHub Actions.
+    # Note: GitHub Actions periodically has outages which result in workflow failures.
+    # In this event, the workflows will start passing again once the service recovers.
+    - cron: "*/5 * * * *"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  report:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment size deltas reports to PRs
+        uses: arduino/report-size-deltas@v1
+        with:
+          # The name of the workflow artifact created by the sketch compilation workflow
+          sketches-reports-source: sketches-reports

.github/workflows/spell-check.yml

@@ -0,0 +1,23 @@
+# Source: https://github.com/arduino/.github/blob/master/workflow-templates/spell-check.md
+name: Spell Check
+
+# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
+on:
+  push:
+  pull_request:
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Spell check
+        uses: codespell-project/actions-codespell@master

examples/Application/IrrigationSimple/AlarmTasks.cpp

@@ -11,7 +11,7 @@
 * In case of TR, TO and RO alarm types, the day of week, hour
 * and minute parameters are ignored.
 * In case of RO alarm type, the second parameters must bean UNIX
-* specied as UNIX timestamp (seconds since EPOCH).
+* specified as UNIX timestamp (seconds since EPOCH).
 *
 * See the TimeAlarms (https://github.com/PaulStoffregen/TimeAlarms)
 * docs for further specs.
@@ -80,4 +80,4 @@ std::list<AlarmTask> parseAlarmTab(File& file)
     }
 
     return taskList;
-}
+}

examples/Application/IrrigationSimple/Helpers.cpp

@@ -10,7 +10,7 @@ void setSystemClock(String compileDate, String compileTime)
     // ... ore use the one from integrated RTC.
     auto rtcTime = time(NULL);
 
-    // Remeber to connect at least the CR2032 battery
+    // Remember to connect at least the CR2032 battery
     // to keep the RTC running.
     auto actualTime = rtcTime > buildTime ? rtcTime : buildTime;
 

examples/Application/IrrigationSimple/IrrigationSimple.ino

@@ -5,7 +5,7 @@
  * - Arduino EdgeControl
  * - MicroSD card
  * - CR2032 Battery and/or 12V Lead Battery
- * - Button connectd to POWER_ON pin on the LCD breakout header
+ * - Button connected to POWER_ON pin on the LCD breakout header
  * 
  * Usage:
  * - Define your callback functions in CustomTasks.{h,cpp}
@@ -76,7 +76,7 @@ void setup()
 
     // Set System and Alarm clock
     // Use compile datetime as proxy clock synch
-    // Use a CR2032 battery for persisten RTC.
+    // Use a CR2032 battery for persistent RTC.
     setSystemClock();
 
     // Init board-related objects
@@ -109,7 +109,7 @@ void setup()
     // AlarmTasks.{h, cpp} source files for documentation.
     loadAndSetTasks(alarmTabIDs);
 
-    // Use the a button for houskeeping stuff:
+    // Use the a button for housekeeping stuff:
     // Single Tap: Show status
     // Double Tap: Reload alarm tasks from SD
     // Triple Tap: Force saving data to SD
@@ -175,4 +175,4 @@ void detectTaps()
         buttonStatus = static_cast<ButtonStatus>(taps);
         taps = 0;
     }
-}
+}

examples/Application/IrrigationSimpleLCD/AlarmTasks.cpp

@@ -11,7 +11,7 @@
 * In case of TR, TO and RO alarm types, the day of week, hour
 * and minute parameters are ignored.
 * In case of RO alarm type, the second parameters must bean UNIX
-* specied as UNIX timestamp (seconds since EPOCH).
+* specified as UNIX timestamp (seconds since EPOCH).
 *
 * See the TimeAlarms (https://github.com/PaulStoffregen/TimeAlarms)
 * docs for further specs.
@@ -80,4 +80,4 @@ std::list<AlarmTask> parseAlarmTab(File& file)
     }
 
     return taskList;
-}
+}

examples/Application/IrrigationSimpleLCD/Helpers.cpp

@@ -10,7 +10,7 @@ void setSystemClock(String compileDate, String compileTime)
     // ... ore use the one from integrated RTC.
     auto rtcTime = time(NULL);
 
-    // Remeber to connect at least the CR2032 battery
+    // Remember to connect at least the CR2032 battery
     // to keep the RTC running.
     auto actualTime = rtcTime > buildTime ? rtcTime : buildTime;