Skip to content

Commit

Permalink
Create firmware.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
k12ish authored May 10, 2024
1 parent e0d0a20 commit a672148
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions .github/workflows/firmware.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Written with https://mirzafahad.github.io/2021-03-09-github-cicd-for-arduino-projects/

# This is the name of the workflow, visible on GitHub UI.
name: Build Firmware

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request only for the main branch
push:
branches: [ main ]
pull_request:
branches: [ main ]

# This is the list of jobs that will be run concurrently.
# Since we use a build matrix, the actual number of jobs
# started depends on how many configurations the matrix
# will produce.
jobs:
# This is the name of the job - can be whatever.
build:
# Here we tell GitHub that the jobs must be determined
# dynamically depending on a matrix configuration.
strategy:
matrix:
# The matrix will produce one job for each configuration
# parameter of type `arduino-platform`, in this case, it
# is only 1.
arduino-platform: ["arduino:avr"]
# This is usually optional but we need to statically define the
# FQBN of the boards we want to test for each platform. In the
# future the CLI might automatically detect and download the
# core needed to compile against a certain FQBN, at that point
# the following `include` section will be useless.
include:
# This works like this: when the platformn is "arduino:avr",
# the variable `fqbn` is set to "arduino:avr:uno".
- arduino-platform: "arduino:avr"
fqbn: "arduino:avr:uno"

runs-on: ubuntu-latest

# full list of steps for "Firmware Build" job
steps:
# First clone the repo using the `checkout` action.
- name: Checkout
uses: actions/checkout@main

# use the `arduino/setup-arduino-cli` action to install/configure the Arduino CLI
- name: Setup Arduino CLI
uses: arduino/setup-arduino-cli@v1.1.1

# We then install the platform, which one will be determined
# dynamically by the build matrix.
- name: Install platform
run: |
arduino-cli core update-index
arduino-cli core install ${{ matrix.arduino-platform }}
# Finally, we compile the sketch, using the FQBN that was set
# in the build matrix.
- name: Compile Sketch
run: arduino-cli compile --fqbn ${{ matrix.fqbn }} ./firmware/firmware.ino --warnings more

0 comments on commit a672148

Please sign in to comment.