Feature/githubci - Githubissues

philj404 commented 3 years ago

FYI here is a github action configuration. It checks whether the arduino-timer library and example code will compile on various platforms.

It uses code in the adafruit/ci-arduino repository to do the build.

This pull request is definitely an enhancement. It may not be in a direction you wanted to go. If that's the case, never mind, just reject it and move on.

However if you were meaning to use continuous integration sometime and hadn't found the time to set it up, here's something that might help.

For more information, see The Well-Automated Arduino Library

Notes:

Currently the adafruit/ci-arduino list of main_platforms does not include ALL platforms by default. This list is maintained by @adafruit, so may grow or shrink at times as platform support "starts working" for them.
I added checks for esp32 and esp8266 platforms, since they seemed to build OK. (these explicit additions may become redundant when they are get folded into main_platforms by default.
Support for nrf52840 doesn't seem to be ready enough yet.
I commented out doxygen support, as doxygen isn't used in this library (and it needs extra github build setup that I didn't get working)

philj404 commented 3 years ago

See https://github.com/contrem/arduino-timer/issues/17 for the associated issue.

philj404 commented 3 years ago

Here are some results builds on my fork. (Let me know if you need more permissions to see this info...) See https://github.com/philj404/arduino-timer/branches for how build status is reported.
https://github.com/philj404/arduino-timer/actions lists recent github actions associated with the repository.

It looks like actions get flushed eventually, so eventually these links will stop working:

https://github.com/philj404/arduino-timer/actions/runs/336782009 shows a build summary.
https://github.com/philj404/arduino-timer/runs/1329427310?check_suite_focus=true gives more details about build success for each configuration. (Not much detail, but at least enough to know which platform to investigate).
A green checkmark shows a build was able to compile in all listed configurations.
A red "X" shows the build was not able to succeed. The build report can tell you which configuration(s) had trouble. You may need to do more investigation to figure out what the actual problem was.

contrem commented 3 years ago

This is great, thanks for sharing. Let me know if you'd like to do any commit squashing / cleanup before merging.

Currently tracking this PR in pj/githubci

philj404 commented 3 years ago

Woo hoo! All builds passed!

I think I'm done with my cleanup -- unless you noticed something I should fix.

If you would like to squash changes, that's fine with me.

(after merging) If you want to only allow passing branch commits/builds to merge to master, you can set that up in "Settings... Branches... Branch Protection Rules" (click on 'Add rule'). It's less important if you are the only person doing a merge.

When I was working on a project with 40+ other developers we required proven-working builds before the merge. It helped keep regressions from slowing everyone else down.

philj404 commented 3 years ago

Whoops. Sorry, I was just checking if I could do the merge by closing the PR. Nope.

contrem commented 3 years ago

Merged in 9532adc30e7b08aad2df6cfb2aaf824760ae345f.

contrem / arduino-timer

Feature/githubci #16