https://github.com/Legion2/arduino-builder-action

Github Action to run arduino-builder for sketches and see if they compile
https://github.com/Legion2/arduino-builder-action

arduino-builder github-actions

Last synced: 7 days ago
JSON representation

Github Action to run arduino-builder for sketches and see if they compile

• Host: GitHub
• URL: https://github.com/Legion2/arduino-builder-action
• Owner: Legion2
• License: apache-2.0
• Created: 2019-02-06T18:26:03.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-31T10:06:43.000Z (over 4 years ago)
• Last Synced: 2024-10-15T07:02:35.847Z (30 days ago)
• Topics: arduino-builder, github-actions
• Language: Shell
• Homepage:
• Size: 10.7 KB
• Stars: 35
• Watchers: 3
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**DEPRECATION WARNING**: Arduino Builder is being phased out in favor of [Arduino CLI](https://github.com/arduino/arduino-cli), I recommend using [Test compile for Arduino](https://github.com/marketplace/actions/test-compile-for-arduino) by ArminJo.

Read [my blog post](https://legion2.github.io/2020/03/27/from-arduino-builder-to-arduino-cli.html) on how to use Arduino CLI in GitHub Actions and how to migrate from this Action to Arduino CLI.

# Run arduino-builder

Github Action to run arduino-builder for sketches and see if they compile.

Used Arduino IDE version is `1.8.3`.

## Usage

See [action.yml](action.yml) for comprehensive list of parameters.

Basic:

```yaml

name: Build examples

on: push

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - name: Build all example sketches

      uses: Legion2/[email protected]

      with:

        board: "arduino:avr:leonardo"

```

### Arguments

Specified arguments override any input parameters passed to arduino-builder, with the exception of the sketch input parameter.

Only use arguments if the input parameters don't provide the feature you need.

See the the [action.yml](action.yml) for comprehensive list of input parameters.

### Install Libraries

Libraries SHOULD be installed by a previous step in the job in `libraries/`.

You can use [Download GitHub Release Action](https://github.com/marketplace/actions/download-github-release) to install a library form a GitHub Release.

## License

The Dockerfile and associated scripts and documentation in this project are released under the [Apache-2.0 License](LICENSE).