-
Notifications
You must be signed in to change notification settings - Fork 167
Use Travis CI for automated testing #64
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
Use Travis CI for automated testing #64
Conversation
As a volunteer project, I prepared a demonstration of how I would configure Travis CI were this my own repository. Example Travis CI build: .travis.yml: Features:
I thought this might provide some ideas for enhancements to Arduino's Travis CI configuration. I'd be happy to add any of the above individual features to this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've reviewed the PR and it looks good to me 👍 @per1234 There is one small request from my side - please add the build-badge to the README page. Otherwise it is good to merge.
Travis CI will compile each of the example sketches for Mega, MKR Zero, Uno WiFi Rev2, and Due using the latest release of arduino-cli every time someone commits to the repository or submits a pull request.
TravisBuddy automatically comments on any pull request that results in a failed Travis CI build. This will cause the author of the pull request to get a notification of the failure and asking them to check the build results to see if they can fix the problem. The hope is that this will result in more pull requests that are valid before a maintainer needs to get involved. It also makes it easier on the pull request author because they don't need to remember to come back to the repository to check the CI build result.
The Artistic Style formatter tool was used with the https://raw.githubusercontent.com/arduino/Arduino/master/build/shared/examples_formatter.conf configuration to format all code in the repository.
Use the Artistic Style formatting tool (also used for the Arduino IDE's auto format feature) to check all code files in the repository for compliance with the Arduino code formatting style.
Use codespell to check for commonly misspelled words during the Travis CI build. In the event of false positives, the words can be added to extras/codespell-ignore-words-list.txt, after which codespell will ignore those words.
@lxrobotics I've added the requested build badge. |
@per1234 Great 👍 You are good to merge. |
Travis CI is used to run the following tests on the repository after every commit or pull request:
arduino-cli
.Although it is not presently needed, I added an empty file:
extras/codespell-ignore-words-list.txt
. This file is to be used in case of false positives during the check for commonly misspelled words (all words in the file are ignored by codespell). My idea was that having the ignore system already in place would reduce the amount of hassle in the event of a false positive. If it is not considered desirable to add this file before it's needed, I'm happy to remove it from this PR.I used the following files as a reference for this PR: