You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-4Lines changed: 14 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,7 @@ If the board is from one of the platforms provided by Arduino's [default package
71
71
72
72
If a platform dependency from a non-Boards Manager source of the same name as another Boards Manager source platform dependency is defined, they will both be installed, with the non-Boards Manager dependency overwriting the Boards Manager platform installation. This permits testing against a non-release version of a platform while using Boards Manager to install the platform's tools dependencies.
73
73
Example:
74
+
74
75
```yaml
75
76
platforms: |
76
77
# Install the latest release of Arduino SAMD Boards and its toolchain via Boards Manager
@@ -85,6 +86,7 @@ platforms: |
85
86
##### Boards Manager
86
87
87
88
Keys:
89
+
88
90
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
89
91
- **`version`** - version of the platform to install.
90
92
- **Default**: the latest version.
@@ -94,14 +96,16 @@ Keys:
94
96
##### Local path
95
97
96
98
Keys:
99
+
97
100
- **`source-path`** - (**required**) path to install as a platform. Relative paths are assumed to be relative to the root of the repository.
98
101
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
99
102
100
103
##### Repository
101
104
102
105
Keys:
106
+
103
107
- **`source-url`** - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
104
-
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
108
+
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
105
109
- **`version`** - [Git ref](https://git-scm.com/book/en/v2/Git-Internals-Git-References) of the repository to checkout. The special version name `latest` will cause the latest tag to be used.
106
110
- **Default**: the repository is checked out to the tip of the default branch.
107
111
- **`source-path`** - path to install as a platform. Paths are relative to the root of the repository.
@@ -110,8 +114,9 @@ Keys:
110
114
##### Archive download
111
115
112
116
Keys:
113
-
- **`source-url`** - (**required**) download URL for the archive (e.g., `https://github.com/arduino/ArduinoCore-avr/archive/master.zip`).
114
-
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
117
+
118
+
- **`source-url`** - (**required**) download URL for the archive (e.g., `https://github.com/arduino/ArduinoCore-avr/archive/master.zip`).
119
+
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
115
120
- **`source-path`** - path to install as a platform. Paths are relative to the root folder of the archive, or the root of the archive if it has no root folder.
116
121
- **Default**: root folder of the archive.
117
122
@@ -131,24 +136,28 @@ Libraries are installed under the Arduino user folder at `~/Arduino/libraries`.
131
136
##### Library Manager
132
137
133
138
Keys:
139
+
134
140
- **`name`** - (**required**) name of the library, as defined in the `name` field of its [library.properties](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format) metadata file.
135
141
- **`version`** - version of the library to install.
136
142
- **Default**: the latest version.
137
143
138
144
**Notes**:
145
+
139
146
- The library will be installed to a folder matching its name, but with any spaces replaced by `_`.
140
147
- If the library's author defined dependencies, those libraries will be installed automatically.
141
148
142
149
##### Local path
143
150
144
151
Keys:
152
+
145
153
- **`source-path`** - (**required**) path to install as a library. Relative paths are assumed to be relative to the root of the repository.
146
154
- **`destination-name`** - folder name to install the library to.
147
155
- **Default**: the folder will be named according to the source repository or subfolder name.
148
156
149
157
##### Repository
150
158
151
159
Keys:
160
+
152
161
- **`source-url`** - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
153
162
- **`version`** - [Git ref](https://git-scm.com/book/en/v2/Git-Internals-Git-References) of the repository to checkout. The special version name `latest` will cause the latest tag to be used.
154
163
- **Default**: the tip of the default branch.
@@ -160,6 +169,7 @@ Keys:
160
169
##### Archive download
161
170
162
171
Keys:
172
+
163
173
- **`source-url`** - (**required**) download URL for the archive (e.g., `https://github.com/arduino-libraries/Servo/archive/master.zip`).
164
174
- **`source-path`** - path to install as a library. Paths are relative to the root folder of the archive, or the root of the archive if it has no root folder.
165
175
- **Default**: root folder of the archive.
@@ -229,7 +239,7 @@ Set to `true` to cause the action to record the compiler warning count for each
Copy file name to clipboardExpand all lines: action.yml
+24-24Lines changed: 24 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -1,49 +1,49 @@
1
-
name: 'Compile Arduino Sketches'
2
-
description: 'Checks whether Arduino sketches will compile and produces a report of data from the compilations'
1
+
name: "Compile Arduino Sketches"
2
+
description: "Checks whether Arduino sketches will compile and produces a report of data from the compilations"
3
3
inputs:
4
4
cli-version:
5
-
description: 'Version of Arduino CLI to use when building'
6
-
default: 'latest'
5
+
description: "Version of Arduino CLI to use when building"
6
+
default: "latest"
7
7
required: true
8
8
fqbn:
9
-
description: 'Full qualified board name, with Boards Manager URL if needed'
10
-
default: 'arduino:avr:uno'
9
+
description: "Full qualified board name, with Boards Manager URL if needed"
10
+
default: "arduino:avr:uno"
11
11
required: true
12
12
libraries:
13
-
description: 'YAML-format list of library dependencies to install'
14
-
default: '- source-path: ./'
13
+
description: "YAML-format list of library dependencies to install"
14
+
default: "- source-path: ./"
15
15
required: true
16
16
platforms:
17
-
description: 'YAML-format list of platform dependencies to install'
18
-
default: ''
17
+
description: "YAML-format list of platform dependencies to install"
18
+
default: ""
19
19
required: true
20
20
sketch-paths:
21
-
description: 'YAML-format list of paths containing sketches to compile.'
22
-
default: '- examples'
21
+
description: "YAML-format list of paths containing sketches to compile."
22
+
default: "- examples"
23
23
required: true
24
24
cli-compile-flags:
25
-
description: 'YAML-format list of flags to add to the Arduino CLI sketch compilation command.'
26
-
default: ''
25
+
description: "YAML-format list of flags to add to the Arduino CLI sketch compilation command."
26
+
default: ""
27
27
required: false
28
28
verbose:
29
-
description: 'Set to true to show verbose output in the log'
30
-
default: 'false'
29
+
description: "Set to true to show verbose output in the log"
30
+
default: "false"
31
31
required: true
32
32
sketches-report-path:
33
-
description: 'Path in which to save a JSON formatted file containing data from the sketch compilations'
34
-
default: 'sketches-reports'
33
+
description: "Path in which to save a JSON formatted file containing data from the sketch compilations"
34
+
default: "sketches-reports"
35
35
required: true
36
36
github-token:
37
-
description: 'GitHub access token used to get information from the GitHub API. Only needed if you are using the deltas report feature in a private repository.'
38
-
default: ''
37
+
description: "GitHub access token used to get information from the GitHub API. Only needed if you are using the deltas report feature in a private repository."
38
+
default: ""
39
39
required: true
40
40
enable-deltas-report:
41
-
description: 'Set to true to cause the action to determine the change in memory usage and compiler warnings of the compiled sketches between the head and base refs of a PR and the immediate parent commit of a push'
42
-
default: 'false'
41
+
description: "Set to true to cause the action to determine the change in memory usage and compiler warnings of the compiled sketches between the head and base refs of a PR and the immediate parent commit of a push"
42
+
default: "false"
43
43
required: true
44
44
enable-warnings-report:
45
-
description: 'Set to true to cause the action to record the compiler warning count for each sketch compilation in the sketches report'
46
-
default: 'false'
45
+
description: "Set to true to cause the action to record the compiler warning count for each sketch compilation in the sketches report"
0 commit comments