Skip to content

Commit d48ac55

Browse files
committed
Bring all files into Prettier formatting style compliance
1 parent df6f433 commit d48ac55

File tree

3 files changed

+53
-48
lines changed

3 files changed

+53
-48
lines changed

.github/workflows/test-integration.yml

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,29 @@ name: Run integration tests
33
on:
44
pull_request:
55
paths:
6-
- '.github/workflows/test-integration.yml'
7-
- '.github/workflows/testdata/**'
8-
- '.python-version'
9-
- 'poetry.lock'
10-
- 'pyproject.toml'
11-
- 'action.yml'
12-
- 'compilesketches/**'
6+
- ".github/workflows/test-integration.yml"
7+
- ".github/workflows/testdata/**"
8+
- ".python-version"
9+
- "poetry.lock"
10+
- "pyproject.toml"
11+
- "action.yml"
12+
- "compilesketches/**"
1313

1414
push:
1515
paths:
16-
- '.github/workflows/test-integration.yml'
17-
- '.github/workflows/testdata/**'
18-
- '.python-version'
19-
- 'poetry.lock'
20-
- 'pyproject.toml'
21-
- 'action.yml'
22-
- 'compilesketches/**'
16+
- ".github/workflows/test-integration.yml"
17+
- ".github/workflows/testdata/**"
18+
- ".python-version"
19+
- "poetry.lock"
20+
- "pyproject.toml"
21+
- "action.yml"
22+
- "compilesketches/**"
2323

2424
env:
2525
SKETCHES_REPORTS_PATH: sketches-reports
2626
TESTDATA_PLATFORMS_PATH: .github/workflows/testdata/platforms
2727
TESTDATA_SKETCHES_PATH: .github/workflows/testdata/sketches
28-
TESTDATA_REPORTS_PATH: .github/workflows/testdata/reports
28+
TESTDATA_REPORTS_PATH: .github/workflows/testdata/reports
2929

3030
jobs:
3131
default-inputs:
@@ -48,7 +48,6 @@ jobs:
4848
# Use action from local path
4949
uses: ./extras/compile-sketches
5050

51-
5251
all-inputs:
5352
runs-on: ubuntu-latest
5453

@@ -119,7 +118,6 @@ jobs:
119118
outputs:
120119
report-artifact-name: ${{ steps.report-artifact-name.outputs.report-artifact-name }}
121120

122-
123121
multiple-steps:
124122
name: multiple-steps (${{ matrix.board.source-type }})
125123
runs-on: ubuntu-latest
@@ -239,7 +237,6 @@ jobs:
239237
sketch-paths: |
240238
- ${{ env.TESTDATA_SKETCHES_PATH }}/BareMinimum
241239
242-
243240
# Targeted testing for ESP32 boards platform support.
244241
pyserial-dependency:
245242
runs-on: ubuntu-latest
@@ -269,7 +266,6 @@ jobs:
269266
sketch-paths: |
270267
- ${{ env.TESTDATA_SKETCHES_PATH }}/BareMinimum
271268
272-
273269
check-sketches-reports:
274270
needs: all-inputs
275271
runs-on: ubuntu-latest
@@ -333,7 +329,6 @@ jobs:
333329
334330
exit $EXIT_STATUS
335331
336-
337332
expected-failed-compilation:
338333
runs-on: ubuntu-latest
339334

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ If the board is from one of the platforms provided by Arduino's [default package
7171

7272
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.
7373
Example:
74+
7475
```yaml
7576
platforms: |
7677
# Install the latest release of Arduino SAMD Boards and its toolchain via Boards Manager
@@ -85,6 +86,7 @@ platforms: |
8586
##### Boards Manager
8687
8788
Keys:
89+
8890
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
8991
- **`version`** - version of the platform to install.
9092
- **Default**: the latest version.
@@ -94,14 +96,16 @@ Keys:
9496
##### Local path
9597

9698
Keys:
99+
97100
- **`source-path`** - (**required**) path to install as a platform. Relative paths are assumed to be relative to the root of the repository.
98101
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
99102

100103
##### Repository
101104

102105
Keys:
106+
103107
- **`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`).
105109
- **`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.
106110
- **Default**: the repository is checked out to the tip of the default branch.
107111
- **`source-path`** - path to install as a platform. Paths are relative to the root of the repository.
@@ -110,8 +114,9 @@ Keys:
110114
##### Archive download
111115

112116
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`).
115120
- **`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.
116121
- **Default**: root folder of the archive.
117122

@@ -131,24 +136,28 @@ Libraries are installed under the Arduino user folder at `~/Arduino/libraries`.
131136
##### Library Manager
132137

133138
Keys:
139+
134140
- **`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.
135141
- **`version`** - version of the library to install.
136142
- **Default**: the latest version.
137143

138144
**Notes**:
145+
139146
- The library will be installed to a folder matching its name, but with any spaces replaced by `_`.
140147
- If the library's author defined dependencies, those libraries will be installed automatically.
141148

142149
##### Local path
143150

144151
Keys:
152+
145153
- **`source-path`** - (**required**) path to install as a library. Relative paths are assumed to be relative to the root of the repository.
146154
- **`destination-name`** - folder name to install the library to.
147155
- **Default**: the folder will be named according to the source repository or subfolder name.
148156

149157
##### Repository
150158

151159
Keys:
160+
152161
- **`source-url`** - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
153162
- **`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.
154163
- **Default**: the tip of the default branch.
@@ -160,6 +169,7 @@ Keys:
160169
##### Archive download
161170

162171
Keys:
172+
163173
- **`source-url`** - (**required**) download URL for the archive (e.g., `https://github.com/arduino-libraries/Servo/archive/master.zip`).
164174
- **`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.
165175
- **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
229239
```yaml
230240
- uses: arduino/compile-sketches@v1
231241
with:
232-
fqbn: 'arduino:avr:uno'
242+
fqbn: "arduino:avr:uno"
233243
libraries: |
234244
- name: Servo
235245
- name: Stepper

action.yml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff 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"
33
inputs:
44
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"
77
required: true
88
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"
1111
required: true
1212
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: ./"
1515
required: true
1616
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: ""
1919
required: true
2020
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"
2323
required: true
2424
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: ""
2727
required: false
2828
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"
3131
required: true
3232
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"
3535
required: true
3636
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: ""
3939
required: true
4040
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"
4343
required: true
4444
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"
46+
default: "false"
4747
required: true
4848

4949
runs:

0 commit comments

Comments
 (0)