Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arduino/setup-arduino-cli
GitHub Action to setup Arduino CLI
https://github.com/arduino/setup-arduino-cli
arduino github-actions tooling-team
Last synced: about 1 month ago
JSON representation
GitHub Action to setup Arduino CLI
- Host: GitHub
- URL: https://github.com/arduino/setup-arduino-cli
- Owner: arduino
- License: mit
- Created: 2019-10-10T11:46:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T22:18:30.000Z (9 months ago)
- Last Synced: 2024-04-13T07:03:54.584Z (7 months ago)
- Topics: arduino, github-actions, tooling-team
- Language: TypeScript
- Homepage:
- Size: 737 KB
- Stars: 74
- Watchers: 15
- Forks: 8
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# setup-arduino-cli
[](https://github.com/arduino/setup-arduino-cli/actions)
This action makes the `arduino-cli` tool available to Workflows.
## Usage
To get the latest stable version of `arduino-cli` just add this step:
```yaml
- name: Install Arduino CLI
uses: arduino/setup-arduino-cli@v2
```
If you want to pin a major or minor version you can use the `.x` wildcard:
```yaml
- name: Install Arduino CLI
uses: arduino/setup-arduino-cli@v2
with:
version: "1.x"
```
To pin the exact version:
```yaml
- name: Install Arduino CLI
uses: arduino/setup-arduino-cli@v2
with:
version: "1.0.1"
```
## Examples
[Here][example] there is a good example on how to use the action.
See also the [Arduino on GitHub Actions blogpost][blogpost] to learn more.
## Development
To work on the codebase you have to install all the dependencies:
```sh
# npm install
```
To run tests set the environment variable `GITHUB_TOKEN` with a valid Personal Access Token and then:
```sh
# npm run test
```
See the [official Github documentation][pat-docs] 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. If the release will increment the major version, update the action refs in the examples in README.md
(e.g., `uses: arduino/setup-arduino-cli@v1` -> `uses: arduino/setup-arduino-cli@v2`).
7. open a PR and request a review.
8. After PR is merged, create a release, following the `vX.Y.Z` tag name convention.
9. After the release, rebase the release branch for that major version (e.g., `v1` branch for the v1.x.x tags) on the
tag. If no branch exists for the release's major version, create one.
[pat-docs]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
[example]: https://github.com/arduino/arduino-cli-example/blob/master/.github/workflows/test.yaml
[blogpost]: https://blog.arduino.cc/2019/11/14/arduino-on-github-actions/
## Security
If you think you found a vulnerability or other security-related bug in this project, please read our
[security policy](https://github.com/arduino/setup-arduino-cli/security/policy) and report the bug to our Security Team 🛡️
Thank you!
e-mail contact: [email protected]