-
Notifications
You must be signed in to change notification settings - Fork 161
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
Modernize continuous integration system #93
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dependabot will periodically check the versions of all actions used in the repository's workflows. If any are found to be outdated, it will submit a pull request to update them. NOTE: Dependabot's PRs will sometimes try to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1` to `uses: foo/bar@v2.3.4`). When the action author has provided a major version ref, use that instead (e.g., `uses: foo/bar@v2`). Dependabot will automatically close its PR once the workflow has been updated. More information: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
Unfortunately, this turned out to be too ambitious of an initiative for Arduino. See arduino-libraries/Arduino_MKRGPS PR# 1 for details.
On every push, pull request, and periodically, use the codespell-project/actions-codespell action to check for commonly misspelled words. In the event of a false positive, the problematic word should be added, in all lowercase, to the ignore-words-list field of ./.codespellrc. Regardless of the case of the word in the false positive, it must be in all lowercase in the ignore list. The ignore list is comma-separated with no spaces.
On every push, pull request, and periodically, run Arduino Lint to check for common problems not related to the project code.
This defines the license in a standardized place, which allows GitHub's automated license detection system to detect the license type: https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository#detecting-a-license This is the exact license text provided by choosealicense.com This text should not be modified in any way. Doing so may interfere with GitHub's license detection or even the licence's function as a legal instrument.
On every push or pull request that affects library source or example files, and periodically, compile all example sketches for the specified boards.
On creation or commit to a pull request, a report of the resulting change in memory usage of the examples will be commented to the PR thread.
aentinger
approved these changes
Apr 12, 2021
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.
LGTM 👍 Thank you @per1234 🚀
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the CI system to the standardized GitHub Actions-based CI configuration for Arduino libraries.
Dependabot
Dependabot will periodically check the versions of all actions used in the repository's workflows. If any are found to be outdated, it will submit a pull request to update them.
NOTE: Dependabot's PRs will sometimes try to pin to the patch version of the action (e.g., updating
uses: foo/bar@v1
touses: foo/bar@v2.3.4
). When the action author has provided a major version ref, use that instead (e.g.,uses: foo/bar@v2
). Once the major version has been updated in the workflow, Dependabot should not submit an update PR again until the next major version bump. So even if the PRs from Dependabot are not always exactly correct, their value lies in bringing the maintainer's attention to the fact that the action version in use is outdated. Dependabot will automatically close its PR once the workflow has been updated.More information:
https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
Spell check
On every push, pull request, and periodically, use the
codespell-project/actions-codespell
action to check for commonly misspelled words.In the event of a false positive, the problematic word should be added, in all lowercase, to the
ignore-words-list
field of./.codespellrc
. Regardless of the case of the word in the false positive, it must be in all lowercase in the ignore list. The ignore list is comma-separated with no spaces.Arduino Lint
On every push, pull request, and periodically, run Arduino Lint to check for common problems not related to the project code.
Compile examples
On every push or pull request that affects library source or example files, and periodically, use the
arduino/compile-sketches
action to compile all example sketches for the specified boards.Report size deltas
On creation or commit to a pull request, use the
arduino/report-size-deltas
action to comment a report of the resulting change in memory usage of the examples to the PR thread.Fixes #88