arduino/actions

Collection of custom Github actions

Arduino GitHub Actions

WARNING: This repository is used for Arduino's development of experimental GitHub Actions. They are unstable and not fully tested. Use at your own risk!

Actions will be moved to dedicated repositories when they are ready for production usage.

Usage information can be found in their respective folders.

• arduino/compile-sketches uses Arduino CLI to do compilation testing of your Arduino library.

  • WARNING: The arduino/actions/libraries/compile-examples action contained in this repository is deprecated. Please use the actively maintained arduino/compile-sketches action at the link above.

• arduino/report-size-deltas comments on pull requests to provide a report of the resulting change in memory usage to the Arduino library's example sketch.

  • WARNING: The arduino/actions/libraries/report-size-deltas action contained in this repository is deprecated. Please use the actively maintained arduino/report-size-deltas action at the link above.

• arduino/report-size-trends records the sketch memory usage data reported by the arduino/compile-sketches action in a Google Sheets spreadsheet.

  • WARNING: The arduino/actions/libraries/report-size-trends action contained in this repository is deprecated. Please use the actively maintained arduino/report-size-trends action at the link above.

• libraries/spell-check checks the files of your repository for commonly misspelled words.

  • WARNING: The arduino/actions/libraries/spell-check action contained in this repository is deprecated. The recommended alternative is the codespell-project/actions-codespell action.

• arduino/setup-task makes Task available to your workflows.

  • WARNING: The arduino/actions/setup-taskfile action contained in this repository is deprecated. Please use the actively maintained arduino/setup-task action at the link above.

---

Note: Several actions previously hosted in this experimental repository have reached stable status and been moved to dedicated repositories:

• arduino/setup-arduino-cli makes the Arduino CLI available to your Workflows.

• arduino/setup-protoc makes the protobuf compiler available to your Workflows.

Security

If you think you found a vulnerability or other security-related bug in this project, please read our security policy and report the bug to our Security Team 🛡️ Thank you!

e-mail contact: [email protected]

actions's Issues

Workflow Templates

This might be interesting:
https://github.blog/2020-06-22-promote-consistency-across-your-organization-with-workflow-templates/

Please add exclude sketch

Hi

Please add commnad for exclude sketch in examples

Install additional dependencies for Dockerfile

Hi,

I am trying to use arduino/actions/libraries/compile-examples for the stm32f103C target (stm32duino/Arduino_Core_STM32. I've added that platform to my repo and specified it via the source-path.

on: ["push"]

jobs:
    arduino:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v2
            - uses: arduino/actions/libraries/compile-examples@master
              with:
                  fqbn: "stm32duino:STM32F1:genericSTM32F103C"
                  platforms: |
                      - source-path: ".github/stm32duino/hardware/STM32F1"
                        name: "stm32duino:STM32F1"
                  sketch-paths: |
                      - first_launch
                  libraries: |
                      - name: MPU6050_tockn
                      - name: MS5611
                      - name: SD
                      # SPI and Wire seem to be available per default
                  enable-deltas-report: true

The "Run arduino/actions/libraries/compile-examples@master" step fail with:

Error during build: fork/exec /bin/arm-none-eabi-g++: no such file or directory

I assume arm-none-eabi-g++ (available in ubuntu repos) is needed for building the sketch for the stm32, which is an arm chip, but I couldn't figure out how to install this into the docker image, without forking the repo.
Is there a way?

Thanks in advance! 👋🏾

Mark the repository as deprecated (use the archive github feature)

I was using this action, but it does not support the repo-token, which is required.

1. actions/runner-images#602 (comment) - API rate limit exceeded for Mac OS hosted by GitHub itself
2. https://help.github.com/en/github/creating-cloning-and-archiving-repositories/archiving-repositories

Warnings in the logs

I'm using this action like this:

- name: Install Taskfile
        uses: arduino/actions/setup-taskfile@master
        with:
          version: '3.x'
          repo-token: ${{ secrets.GITHUB_TOKEN }}

and I'm getting this warnings:

Warning: Unexpected input(s) 'repo-token', valid inputs are ['version']

Warning: The add-path command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/

Am I missing something?

Add ability to exclude directories for spell-check action.

Since we often bundle external resources with our libraries it doesn't make sense to check those files for misspelled words if they are being maintained upstream. Therefore the spell-check should be extended to allow the specification of directories which need to be excluded from the spell verification.

@per1234 - I've just added this issue here so in order to keep track of this feature (since its easy to loose track of tasks just mentioned on slack).

Error when using Taskfile installation action

I'm trying to use your Taskfile action in one of my repos.
The Taskfile installation action succeeds but but I got this error when trying to invoke a task defined in Taskfile.yml:

##[debug]Evaluating condition for step: 'Build'
##[debug]Evaluating: success()
##[debug]Evaluating success:
##[debug]=> true
##[debug]Result: true
##[debug]Starting: Build
##[debug]Loading inputs
##[debug]Loading env
Run task build
##[debug]/bin/bash -e /home/runner/work/_temp/64677591-7311-4720-bc1f-1d8822b873af.sh
task: No Taskfile found on "Taskfile.yml". Use "task --init" to create a new one
##[error]Process completed with exit code 1.
##[debug]Finishing: Build

Am I missing something obvious here? Thanks!

Specify desired core version in CI build

Sometimes it is necessary to not just use the latest version of a Arduino core in a CI build but to specify a specific version.

In case of the ESP8266 Arduino core with version 2.5.0 this could look like this ...

'"esp8266:esp8266:huzzah" "https://arduino.esp8266.com/stable/package_esp8266com_index.json" "2.5.0"' 

Rate limit error installing Taskfile

Hi,

Just received the following error using the setup-taskfile GH action.

Run Arduino/actions/setup-taskfile@master
  with:
    version: 2.x
  env:
    AWS_ACCESS_KEY_ID: ***
    AWS_SECRET_ACCESS_KEY: ***
    AWS_REGION: eu-west-2
    TF_WORKSPACE: staging
    GOROOT: /opt/hostedtoolcache/go/1.13.15/x64
##[error]API rate limit exceeded for 40.114.46.0. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)

The example workflow fails during update-index

Run arduino-cli core update-index
Error initializing package manager: cannot initialize package manager: loading hardware packages: loading hardware from C:\Users\runneradmin\AppData\Local\Arduino15\packages: C:\Users\runneradmin\AppData\Local\Arduino15\packages is not a directory
Error initializing package manager: cannot initialize package manager: loading hardware packages: loading hardware from C:\Users\runneradmin\AppData\Local\Arduino15\packages: C:\Users\runneradmin\AppData\Local\Arduino15\packages is not a directory
##[error]Process completed with exit code 1.