Skip to content

Commit c9e814b

Browse files
authored
Add comment to "Compile Examples" workflow re: esp8266:esp8266 version
A specific version of the "esp8266" boards platform is installed on the Arduino Cloud servers. Since that is the primary environment the sketches using this library are compiled in, it is necessary for the "Compile Examples" GitHub Actions workflow to use the same version of the platform when running the test compilations of the library examples in order to ensure the results from the CI system will match those from real usage. This requirement is not obvious. Since the workflow does not pin the other platform versions (because Arduino Cloud typically uses the latest version), the pinning of this platform specifically might be the source of confusion for the maintainers. So it is worth documenting the reason.
1 parent 31fcfed commit c9e814b

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

Diff for: .github/workflows/compile-examples.yml

+1
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ jobs:
157157
# Install ESP8266 platform via Boards Manager
158158
- name: esp8266:esp8266
159159
source-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json
160+
# Use the version currently installed in Arduino Cloud
160161
version: 2.5.0
161162
libraries:
162163
sketch-paths:

0 commit comments

Comments
 (0)