Skip to content

Use GitHub Actions for CI #13

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 4 commits into from
Dec 23, 2020
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
65 changes: 65 additions & 0 deletions .github/workflows/compile-examples.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Compile Examples

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

jobs:
build:
runs-on: ubuntu-latest

env:
SKETCHES_REPORTS_PATH: sketches-reports

strategy:
fail-fast: false

matrix:
fqbn:
- arduino:samd:arduino_zero_edbg
- arduino:samd:mkr1000
- arduino:samd:mkrzero
- arduino:samd:mkrwifi1010
- arduino:samd:nano_33_iot
- arduino:samd:mkrfox1200
- arduino:samd:mkrwan1300
- arduino:samd:mkrwan1310
- arduino:samd:mkrgsm1400
- arduino:samd:mkrnb1500
- arduino:samd:mkrvidor4000

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

- name: Compile examples
uses: arduino/compile-sketches@main
with:
fqbn: ${{ matrix.fqbn }}
libraries: |
# Install the AudioZero library from the local path
- source-path: ./
- name: SD
sketch-paths: |
- examples
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 }}
18 changes: 18 additions & 0 deletions .github/workflows/report-size-deltas.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Report Size Deltas

on:
schedule:
- cron: "*/5 * * * *"
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch
workflow_dispatch:

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
26 changes: 26 additions & 0 deletions .github/workflows/spell-check.yml
Original file line number Diff line number Diff line change
@@ -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
13 changes: 10 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
= AudioZero Library for Arduino =
// Define the repository information in these attributes
:repository-owner: arduino-libraries
:repository-name: AudioZero

The AudioZero library enables an Arduino SAMD Board (e.g., https://store.arduino.cc/catalogsearch/result/?q=mkr[MKR boards], https://store.arduino.cc/arduino-nano-33-iot[Nano 33 IoT], https://store.arduino.cc/arduino-zero[Zero]) to play back .wav files from a storage device like an SD card to the `DAC0`/`A0` pin.
= {repository-name} library for Arduino =

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"]

The {repository-name} library enables an Arduino SAMD Board (e.g., https://store.arduino.cc/catalogsearch/result/?q=mkr[MKR boards], https://store.arduino.cc/arduino-nano-33-iot[Nano 33 IoT], https://store.arduino.cc/arduino-zero[Zero]) to play back .wav files from a storage device like an SD card to the `DAC0`/`A0` pin.
For more information about this library please visit us at
https://www.arduino.cc/en/Reference/AudioZero
https://www.arduino.cc/en/Reference/{repository-name}

== License ==

Expand Down
Empty file.
2 changes: 1 addition & 1 deletion keywords.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#######################################
# Syntax Coloring Map For Audio
# Syntax Coloring Map For AudioZero
#######################################

#######################################
Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version=1.1.1
author=Arduino
maintainer=Arduino <[email protected]>
sentence=Allows playing audio files from an SD card. For Arduino Zero, MKRZero and MKR1000 only.
paragraph=With this library you can use the Arduino Zero ort MKR1000 DAC output (A0) to play audio files.<br />The audio files must be in the raw .wav format.
paragraph=With this library you can use the Arduino Zero or MKR1000 DAC output (A0) to play audio files.<br />The audio files must be in the raw .wav format.
category=Signal Input/Output
url=https://www.arduino.cc/en/Reference/Audio
architectures=samd