Skip to content

henrygab/setup-arduino-cli

Repository files navigation

setup-arduino-cli

Actions Status

This action makes the arduino-cli tool available to Workflows.

Usage

To get the latest stable version of arduino-cli just add this step:

- name: Install Arduino CLI
  uses: arduino/[email protected]

If you want to pin a major or minor version you can use the .x wildcard:

- name: Install Arduino CLI
  uses: arduino/[email protected]
  with:
    version: "0.x"

To pin the exact version:

- name: Install Arduino CLI
  uses: arduino/[email protected]
  with:
    version: "0.5.0"

Examples

Here there is a good example on how to use the action. See also the Arduino on GitHub Actions blogpost to learn more.

Development

To work on the codebase you have to install all the dependencies:

# npm install

To run tests set the environment variable GITHUB_TOKEN with a valid Personal Access Token and then:

# npm run test

See the official Github documentation to know more about Personal Access Tokens.

Release

  1. npm install to add all the dependencies, included development.
  2. npm run build to build the Action under the ./lib folder.
  3. npm run test to see everything works as expected.
  4. npm run pack to package for distribution
  5. git add src dist to check in the code that matters.
  6. open a PR and request a review.

About

GitHub Action to setup Arduino CLI

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 97.5%
  • JavaScript 2.5%