Skip to content

Remove unnecessary steps from "Compile Examples" CI workflow #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 7, 2021
Merged

Conversation

per1234
Copy link

@per1234 per1234 commented Feb 7, 2021

The "Compile Examples" GitHub Actions workflow contained some unnecessary steps. In addition to being not ideal from a maintenance and efficiency standpoint, the configuration was actually causing the workflow to fail.

The arduino/actions/libraried/compile-examples action's installation of the electroniccats:mbed package via Boards
Manager installs the platform's tools dependencies, so it's not necessary to do this separately.
Unlike the arduino:mbed platform, this repository contains a bundled copy of ArduinoCore-API, so there is no need for
the workflow to do it.
There were two electroniccats:mbed platform dependency definitions listed in the
arduino/actions/libraries/compile-examples action's platforms input. The one that specifies the package index URL is the
complete one and the other is unnecessary.
@per1234
Copy link
Author

per1234 commented Feb 7, 2021

Because I'm not familiar with this platform, I had to make some guesses about how the workflow should be configured. It's possible that some of the things I removed were put there for purposes I didn't understand, so please have a look and let me know if I've missed the mark.

An optional improvement I would suggest is to switch to using the maintained version of the sketch compilation action. The arduino/actions/libraries/compile-examples action in use by the workflow has since been moved to a dedicated repository:
https://github.com/arduino/compile-sketches
and the version left behind in the experimental arduino/actions repository is no longer maintained. The old action version in use now should probably work OK, but there have been some advancements since the move.

@sabas1080 sabas1080 self-requested a review February 7, 2021 02:32
@sabas1080
Copy link
Member

Ey thanks! @per1234 , I'm going to move to https://github.com/arduino/compile-sketches in the next pullrequest

@sabas1080 sabas1080 merged commit 963c83d into ElectronicCats:master Feb 7, 2021
@per1234
Copy link
Author

per1234 commented Feb 7, 2021

You're welcome. Please let me know if you run into any problems when migrating to arduino/compile-sketches. The important thing to note is there is one breaking change: arduino/compile-sketches#7
Other than that, it's just a matter of changing the action name.

You also might like to take advantage of this new sketch-paths input format: arduino/actions#74
The old one is still supported, but I think the new style is a lot nicer to work with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants