Skip to content

Commit 72d8b40

Browse files
committed
Update lists of supported project types in docs
The documentation for the `project-type` input was written at the time of the initial release of the project. At that time Arduino Lint only had full support for sketch and library project types, but the support for boards platforms and package indexes was incomplete. Since that time, full support has been added for boards platforms and package indexes but the action's documentation was not updated accordingly.
1 parent 86c20b6 commit 72d8b40

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ projects:
1111
- Libraries
1212
- Sketches
1313
- Boards platforms
14+
- Boards Manager package indexes
1415

1516
## Table of contents
1617

@@ -78,6 +79,8 @@ Configures which types of projects to check, along with their subprojects.
7879

7980
- `sketch`
8081
- `library`
82+
- `platform` - [boards platform](https://arduino.github.io/arduino-cli/latest/platform-specification/)
83+
- `package-index` - Boards Manager [package index](https://arduino.github.io/arduino-cli/latest/package_index_json-specification/)
8184
- `all` - Run checks on any type of project that is detected
8285

8386
**Default**: `all`

0 commit comments

Comments
 (0)