Skip to content

Use GitHub Actions for continuous integration #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 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 = ,
check-filenames =
check-hidden =
skip = ./.git
10 changes: 10 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# See: https://docs.github.com/en/github/administering-a-repository/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/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
- package-ecosystem: github-actions
directory: / # Check the repository's workflows under /.github/workflows/
schedule:
interval: daily
28 changes: 28 additions & 0 deletions .github/workflows/check-arduino.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Check Arduino

# See: https://docs.github.com/en/free-pro-team@latest/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
library-manager: update
# Always use this setting for official repositories. Remove for 3rd party projects.
official: true
project-type: library
78 changes: 78 additions & 0 deletions .github/workflows/compile-examples.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Compile Examples

# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
on:
push:
paths:
- ".github/workflows/compile-examples.yml"
- "library.properties"
- "examples/**"
- "src/**"
pull_request:
paths:
- ".github/workflows/compile-examples.yml"
- "library.properties"
- "examples/**"
- "src/**"
schedule:
# Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms).
- cron: "0 8 * * TUE"
workflow_dispatch:
repository_dispatch:

jobs:
build:
name: ${{ matrix.board.fqbn }}
runs-on: ubuntu-latest

env:
SKETCHES_REPORTS_PATH: sketches-reports

strategy:
fail-fast: false

matrix:
board:
- fqbn: arduino:mbed_nano:nano33ble
platforms: |
- name: arduino:mbed_nano
libraries: |
- name: Arduino_APDS9960
- name: Arduino_HTS221
- name: Arduino_LPS22HB
- name: Arduino_LSM9DS1
sketch-paths: examples/Nano33BLESenseFirmware
- fqbn: arduino:samd:mkrwifi1010
platforms: |
- name: arduino:samd
libraries: |
- name: ArduinoBLE
- name: Adafruit LSM9DS1 Library
sketch-paths: examples/PhysicsLabFirmware

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Compile examples
uses: arduino/compile-sketches@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
fqbn: ${{ matrix.board.fqbn }}
platforms: ${{ matrix.board.platforms }}
libraries: |
# Install the library from the local path.
- source-path: ./
# Board-specific library dependencies
${{ matrix.board.libraries }}
sketch-paths: |
${{ matrix.board.sketch-paths }}
enable-deltas-report: true
sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}

- name: Save sketches report as workflow artifact
uses: actions/upload-artifact@v2
with:
if-no-files-found: error
path: ${{ env.SKETCHES_REPORTS_PATH }}
name: ${{ env.SKETCHES_REPORTS_PATH }}
24 changes: 24 additions & 0 deletions .github/workflows/report-size-deltas.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Report Size Deltas

# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
on:
push:
paths:
- ".github/workflows/report-size-deltas.yml"
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
22 changes: 22 additions & 0 deletions .github/workflows/spell-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Spell Check

# See: https://docs.github.com/en/free-pro-team@latest/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
9 changes: 8 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
= Arduino_ScienceJournal Library for Arduino =
:repository-owner: arduino-libraries
:repository-name: Arduino_ScienceJournal

= {repository-name} Library for Arduino =

image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"]
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"]
image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"]

Firmware for the Physics Lab kit and the Arduino Nano 33 BLE Sense.

Expand Down
6 changes: 3 additions & 3 deletions examples/PhysicsLabFirmware/PhysicsLabFirmware.ino
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,13 @@ void setup() {
digitalWrite(RESISTANCE_AUX_PIN, LOW);

if (!INA226.begin(0x45)) {
Serial.println("Failled to initialized INA226!");
Serial.println("Failed to initialized INA226!");

while (1);
}

if (!imu.begin()) {
Serial.println("Failled to initialized IMU!");
Serial.println("Failed to initialized IMU!");

while (1);
}
Expand All @@ -97,7 +97,7 @@ void setup() {
imu.setupGyro(imu.LSM9DS1_GYROSCALE_245DPS);

if (!BLE.begin()) {
Serial.println("Failled to initialized BLE!");
Serial.println("Failed to initialized BLE!");

while (1);
}
Expand Down
4 changes: 2 additions & 2 deletions extras/BLE_spec BLE Sense Firmware.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
BLE Sense - BLE specifications.txt
==================================

GAP (Adversisement)
GAP (Advertisement)
-------------------
Local name: BLESense - <last 4 characters of BT address>
Serivice UUID: 555a0002-0000-467a-9538-01f0652c74e8
Service UUID: 555a0002-0000-467a-9538-01f0652c74e8


GATT
Expand Down
6 changes: 3 additions & 3 deletions extras/BLE_spec MKR Science Kit Firmware.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ MKR Science Kit Firmware - BLE specifications.txt
=================================================


GAP (Adversisement)
GAP (Advertisement)
-------------------
Local name: MKRSci<last 4 characters of BT address>
Serivice UUID: 555a0001-0000-467a-9538-01f0652c74e8
Service UUID: 555a0001-0000-467a-9538-01f0652c74e8


GATT
Expand Down Expand Up @@ -114,7 +114,7 @@ UUID: 555a0001-5001-467a-9538-01f0652c74e8
Properties: notify
Value size: 12 bytes
Data format: Array of 3 x 32-bit IEEE floats (little endian)
Description: X, Y, Z acceleration values in G's, if subscribed notification sent every 10 ms
Description: X, Y, Z acceleration values in g's, if subscribed notification sent every 10 ms

Gyroscope Characteristic
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down