Skip to content

Allow platforms without fixed version in profiles. #2940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 4, 2025
Merged

Allow platforms without fixed version in profiles. #2940

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef23177
Allow platforms without fixed version in profiles.
cmaglie Jun 30, 2025
d486102
Correctly mark package manager instance as "under profile"
cmaglie Jun 30, 2025
c74b490
Improved error checks in profile loading
cmaglie Jul 3, 2025
863f46e
Updated docs
cmaglie Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Updated docs
  • Loading branch information
@cmaglie
cmaglie committed Jul 3, 2025
commit 863f46e86129dcdd7ea2755a23b2e71a4826bdab
12 changes: 10 additions & 2 deletions docs/sketch-project-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ profiles:
fqbn: <FQBN>
programmer: <PROGRAMMER>
platforms:
- platform: <PLATFORM> (<PLATFORM_VERSION>)
- platform: <PLATFORM> [(<PLATFORM_VERSION>)]
platform_index_url: <3RD_PARTY_PLATFORM_URL>
- platform: <PLATFORM_DEPENDENCY> (<PLATFORM_DEPENDENCY_VERSION>)
- platform: <PLATFORM_DEPENDENCY> [(<PLATFORM_DEPENDENCY_VERSION>)]
platform_index_url: <3RD_PARTY_PLATFORM_DEPENDENCY_URL>
libraries:
- <INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)
Expand Down Expand Up @@ -73,6 +73,14 @@ The following fields are available since Arduino CLI 1.1.0:
`baudrate: 115200`) but any setting/value can be specified. Multiple settings can be set. These fields are optional.
- `<PORT_PROTOCOL>` is the protocol for the port used to upload and monitor the board. This field is optional.

#### Using a system-installed platform.

The fields `<PLATFORM_VERSION>` and `<PLATFORM_DEPENDENCY_VERSION>` are optional, if they are omitted, the sketch
compilation will use the platforms installed system-wide. This could be helpful during the development of a platform
(where a specific release is not yet available), or if a specific version of a platform is not a strict requirement.

#### An example of a complete project file.

A complete example of a sketch project file may be the following:

```
Expand Down