Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arduino/arduino-lint-action
GitHub Actions action to check Arduino projects for problems
https://github.com/arduino/arduino-lint-action
arduino ci continuous-integration github-actions linter
Last synced: about 1 month ago
JSON representation
GitHub Actions action to check Arduino projects for problems
- Host: GitHub
- URL: https://github.com/arduino/arduino-lint-action
- Owner: arduino
- License: mit
- Created: 2020-12-07T10:53:28.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T07:17:21.000Z (about 1 month ago)
- Last Synced: 2024-10-04T20:30:52.495Z (about 1 month ago)
- Topics: arduino, ci, continuous-integration, github-actions, linter
- Language: TypeScript
- Homepage:
- Size: 3.5 MB
- Stars: 44
- Watchers: 10
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# `arduino/arduino-lint-action`
[](https://github.com/arduino/arduino-lint-action/actions?workflow=Test+Action)
[](https://github.com/arduino/arduino-lint-action/actions?workflow=Integration+Tests)
[](https://github.com/arduino/arduino-lint-action/actions/workflows/check-packaging-ncc-typescript-npm.yml)
[](https://github.com/arduino/arduino-lint-action/actions/workflows/check-tsconfig.yml)
[](https://github.com/arduino/arduino-lint-action/actions/workflows/check-npm.yml)
[](https://github.com/arduino/arduino-lint-action/actions?workflow=Spell+Check)
[GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions) action that uses
[Arduino Lint](https://github.com/arduino/arduino-lint) to check for problems with [Arduino](https://www.arduino.cc/)
projects:
- Libraries
- Sketches
- Boards platforms
- Boards Manager package indexes
## Table of contents
- [Inputs](#inputs)
- [`path`](#path)
- [`version`](#version)
- [`compliance`](#compliance)
- [`library-manager`](#library-manager)
- [`project-type`](#project-type)
- [`recursive`](#recursive)
- [`report-file`](#report-file)
- [`verbose`](#verbose)
- [`token`](#token)
- [Usage](#usage)
- [Contributing](#contributing)
## Inputs
### `path`
Path containing Arduino project(s).
**Default**: `./`
### `version`
The version of [Arduino Lint](https://github.com/arduino/arduino-lint) to use.
Can be an exact version (e.g., `1.0.0`) or a version range (e.g., `1.x`).
**Default**: `1.x`
### `compliance`
Configure how strict the tool is about which checks are considered errors vs warnings if they don't pass.
#### Supported values
- `strict` - enforces best practices, above and beyond the minimum requirements for specification compliance. Use this setting to ensure the best experience for the users of the project.
- `specification` - enforces compliance with the official Arduino project specifications.
- `permissive` - will cause the checks to fail only when severe problems are found. Although a project that passes at the permissive setting will work with the current Arduino development software versions, it may not be fully specification-compliant, risking incompatibility or a poor experience for the users.
**Default**: `specification`
### `library-manager`
Configure the checks for libraries in the [Arduino Library Manager](https://github.com/arduino/library-registry/blob/main/FAQ.md#readme) index.
#### Supported values
- `submit` - Also run additional checks required to pass before a library is accepted for inclusion in the index.
- `update`- Also run additional checks required to pass before new releases of a library already in the index are accepted.
- `false` - Don't run any Library Manager-specific checks.
**Default**: `submit` for libraries, `false` for other project types
### `project-type`
Configures which types of projects to check, along with their subprojects.
#### Supported values
- `sketch`
- `library`
- `platform` - [boards platform](https://arduino.github.io/arduino-cli/latest/platform-specification/)
- `package-index` - Boards Manager [package index](https://arduino.github.io/arduino-cli/latest/package_index_json-specification/)
- `all` - Run checks on any type of project that is detected
**Default**: `all`
### `recursive`
Set to `true` to search path recursively for Arduino projects to check.
**Default**: `false`
### `report-file`
Save a JSON formatted report on the checks to this file.
### `verbose`
Set to `true` to show more information in the log about the checks being run.
**Default**: `false`
### `token`
GitHub access token used to get information from the GitHub API.
**Default**: [`GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)
## Usage
The minimal workflow to run the default checks on the projects in the repository:
```yaml
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: arduino/arduino-lint-action@v1
```
A more complex workflow which uses [inputs](#inputs) to configure the action for Library Manager ["update" mode](#library-manager) and strict compliance:
```yaml
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: arduino/arduino-lint-action@v1
with:
library-manager: update
compliance: strict
```
## Contributing
To report bugs or make feature requests, please submit an issue: https://github.com/arduino/arduino-lint-action/issues
Pull requests are welcome! Please see the [contribution guidelines](.github/CONTRIBUTING.md) for information.