Skip to content
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 GitHub Actions for continuous integration #102

Merged
merged 6 commits into from
Apr 14, 2021
Merged

Use GitHub Actions for continuous integration #102

merged 6 commits into from
Apr 14, 2021

Conversation

per1234
Copy link

@per1234 per1234 commented Apr 12, 2021

This PR provides 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 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). 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 #98

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
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.
@per1234 per1234 added the type: enhancement Proposed improvement label Apr 12, 2021
@per1234 per1234 requested a review from aentinger April 12, 2021 05:09
LICENSE.txt Outdated Show resolved Hide resolved
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.
Copy link

@aentinger aentinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic work! Thank you @per1234 🐎

@aentinger aentinger merged commit 1751e10 into master Apr 14, 2021
@aentinger aentinger deleted the ci branch April 14, 2021 05:16
@per1234 per1234 added the topic: infrastructure Related to project infrastructure label Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add GitHub Action based CI
2 participants