Skip to content

Commit 75d6299

Browse files
author
Paul
committed
More specific about where the platform for test control files comes from, with an example.
1 parent a5e740c commit 75d6299

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,17 @@ Additionally, [UF2 files](https://github.com/microsoft/uf2) of the compiled sket
2828

2929
The script behavior can be controlled using special filenames:
3030

31-
* `.YOUR_PLATFORM_HERE.test.skip` - Skip the specified platform. All others are tested.
32-
* `.YOUR_PLATFORM_HERE.test.only` - Test the specified platform. All others are skipped.
33-
* `.YOUR_PLATFORM_HERE.generate` - Generate UF2 of sketch for specified platform (if supported).
31+
* `.PLATFORM_ID.test.skip` - Skip the specified platform. All others are tested.
32+
* `.PLATFORM_ID.test.only` - Test the specified platform. All others are skipped.
33+
* `.PLATFORM_ID.generate` - Generate UF2 of sketch for specified platform (if supported).
3434

35-
These are just empty files placed in an example folder. Replace `YOUR_PLATFORM_HERE` in the name with exact text from `ALL_PLATFORMS`. You can use several `.PLATFORM.test.skip` or `.PLATFORM.test.only` to exclude or include multiple platforms. For example:
35+
These are just empty files placed in an example folder. Replace `PLATFORM_ID` in the name with the key from [`ALL_PLATFORMS`](ci-arduino/blob/master/build_platform.py#L54). `metro_m0` from the following line in `build_platform.py`, for example:
36+
37+
```python
38+
"metro_m0" : ["adafruit:samd:adafruit_metro_m0", "0x68ed2b88", None],
39+
```
40+
41+
You can use several `.PLATFORM_ID.test.skip` or `.PLATFORM_ID.test.only` to exclude or include multiple platforms. For example:
3642

3743
* To **skip** testing on ESP8266, add a file named `.esp8266.test.skip`
3844
* To test **only** the Arduino UNO, add a file named `.uno.test.only`

0 commit comments

Comments
 (0)