File tree Expand file tree Collapse file tree 2 files changed +10
-12
lines changed
Expand file tree Collapse file tree 2 files changed +10
-12
lines changed Original file line number Diff line number Diff line change 1- Arduino CLI provides support for reproducible builds through the use of build profiles.
1+ Sketch metadata is defined in a file named ` sketch.yaml ` . This file is in YAML format.
2+
3+ ## Build profiles
24
3- ## Sketch project file ` sketch.yaml ` and build profiles.
5+ Arduino CLI provides support for reproducible builds through the use of build profiles.
46
5- A profile is a complete description of all the resources needed to build a sketch. Profiles are defined in a project
6- file called ` sketch.yaml ` . This file is in YAML format and may contain multiple profiles.
7+ A profile is a complete description of all the resources needed to build a sketch. The sketch project file may contain
8+ multiple profiles.
79
810Each profile will define:
911
@@ -49,7 +51,7 @@ otherwise below). The available fields are:
4951- ` <LIB_VERSION> ` is the version required for the library, for example, ` 1.0.0 ` .
5052- ` <USER_NOTES> ` is a free text string available to the developer to add comments.
5153
52- A complete example of a ` sketch.yaml ` may be the following:
54+ A complete example of a sketch project file may be the following:
5355
5456```
5557profiles:
@@ -105,7 +107,7 @@ arduino-cli compile --profile nanorp
105107```
106108
107109In this case, the sketch will be compiled using the core platform and libraries specified in the nanorp profile. If a
108- core platform or a library is missing it will be automatically downloaded and installed on the fly in a isolated
110+ core platform or a library is missing it will be automatically downloaded and installed on the fly in an isolated
109111directory inside the data folder. The dedicated storage is not accessible to the user and is meant as a "cache" of the
110112resources used to build the sketch.
111113
Original file line number Diff line number Diff line change @@ -79,16 +79,12 @@ The `included_libs` key defines the library versions the Arduino Web Editor uses
7979Arduino Web Editor specific because all versions of all the Library Manager libraries are pre-installed in Arduino Web
8080Editor, while only one version of each library may be installed when using the other Arduino development software.
8181
82- ### Build profiles and reproducible builds
82+ ### Sketch project file
8383
84- Arduino CLI provides support for reproducible builds through the use of a project file ` sketch.yaml ` .
84+ This is an optional file named ` sketch.yaml ` , located in the root folder of the sketch.
8585
8686Inside ` sketch.yaml ` the user can define one or more "profiles": each profile is a description of all the resources
8787needed to build the sketch (platform and libraries each pinned to a specific version).
88-
89- When using a profile to compile, Arduino CLI will install all the required resources in a isolated environment, used
90- only for the build, leaving the libraries and platforms installed globally in the system untouched.
91-
9288For more information see the [ sketch project file] ( sketch-project-file.md ) documentation.
9389
9490### Secrets
You can’t perform that action at this time.
0 commit comments