Skip to content

Use Github workflows to compile examples and spell check #34

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

Conversation

sandeepmistry
Copy link
Contributor

Alternative to PR #31 and #32.

Uses compile-examples action from: https://github.com/arduino-libraries/actions

This will allow us to have a super minimal .yml file in all arduino-libraries repos, and re-use a common action from a central Github repo.

@sandeepmistry
Copy link
Contributor Author

@facchinm @cmaglie @lxrobotics @mastrolinux @rsora please review this along with https://github.com/arduino-libraries/actions/tree/master/compile-examples (which is based on https://help.github.com/en/articles/creating-a-docker-container-action).

@rsora was in favour of use Node.js instead of Docker + bash for the common Github action in terms of testability, but I think this is good to get us going for now. We can introduce Node.js down the road as needed.

@aentinger
Copy link
Contributor

👍 I like how clean everything is. Doesn't need a rocket scientist to comprehend what's happening. Nice work 😉

@rsora
Copy link

rsora commented Oct 3, 2019

Please do not let bash proliferate 😸

Anyway, the action properly hides the boilerplate so 👍 from me.

May I suggest to move the https://github.com/arduino-libraries/actions/tree/master/compile-examples code to https://github.com/arduino/actions?
This way we will have a single consistent point of access for all our actions in the future (good also for us maintainers and users).

@sandeepmistry sandeepmistry force-pushed the arduino-libraries-github-action branch 5 times, most recently from 58d1edd to e3d07c8 Compare October 3, 2019 19:47
@sandeepmistry
Copy link
Contributor Author

I've added spell check support In: https://github.com/arduino-libraries/actions/tree/master/spell-check (it uses code spell) ... this works and I've fixed some spelling :)

May I suggest to move the https://github.com/arduino-libraries/actions/tree/master/compile-examples code to https://github.com/arduino/actions?

@rsora I think I'm ok with this, we might need to rename the action names to indicate they are for Arduino Libraries only, with we get for free sort of because of arduino-libraries/actions

@rsora
Copy link

rsora commented Oct 4, 2019

@rsora I think I'm ok with this, we might need to rename the action names to indicate they are for Arduino Libraries only, with we get for free sort of because of arduino-libraries/actions

@sandeepmistry as per https://help.github.com/en/articles/workflow-syntax-for-github-actions#example-using-a-public-action-in-a-subdirectory we should be able to do something like this
uses: arduino/actions/libraries/compile-examples@master WDYT?

@sandeepmistry
Copy link
Contributor Author

sandeepmistry commented Oct 4, 2019

uses: arduino/actions/libraries/compile-examples@master WDYT?

@rsora excellent suggestion! Stay tuned for a pull request in that repo! #hacktoberfest

@sandeepmistry sandeepmistry force-pushed the arduino-libraries-github-action branch from 2b51eb9 to aa38994 Compare October 4, 2019 16:16
@sandeepmistry sandeepmistry requested a review from cmaglie October 4, 2019 16:18
@sandeepmistry
Copy link
Contributor Author

This should be good to go now, I've removed the Travis CI config as well. We need to re-add the badges to the read me once merged.

@sandeepmistry sandeepmistry changed the title [DO NOT MERGE] Compile library examples via Github actions @sandeepmistry Use Github workflows to compile examples and spell check Oct 4, 2019
@sandeepmistry sandeepmistry changed the title @sandeepmistry Use Github workflows to compile examples and spell check Use Github workflows to compile examples and spell check Oct 4, 2019
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.

3 participants