Update CI workflows to modern standards #40
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
The arduino/actions/libraries/spell-check action previously in use is deprecated. 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.
The following additional events now trigger the workflow: - Weekly scheduled trigger. This would catch breakage caused by the external library and platform dependencies. - Trigger via the GitHub web interface. - Trigger via the GitHub API.
The official dedicated repository for the Arduino sketch compilation GitHub Actions action is now arduino/compile-sketches. Since the time the action was moved, there was a breaking change to the default sketches report file name. Rather than continuing to rely on the default value, a specific file name is now defined in the workflow.
The API of the arduino/compile-sketches GitHub Actions action has evolved since the time this repository's CI was set up. Although backwards compatibility with the previous API was retained, its use is deprecated and results in potentially confusing warnings.
…requests The arduino/compile-sketches GitHub Actions action needs to do a GitHub API request to determine the base branch of a PR for the deltas determination. If a token is not defined via the action's `github-token` input, it does an unauthenticated API request, which is subject to more strict rate limiting policy. Although its unlikely for the number of API requests to exceed the unauthentticated allowance, use of a token ensures it will never happen. GitHub Actions provides a token for this purpose, so there is no need to set up a custom one.
The following additional events now trigger the workflow: - Pushed commit that modifys the action's workflow. This is useful for verifying that the change was correct. - Trigger via the GitHub web interface. - Trigger via the GitHub API.
Since the time the CI system for this repository was set up, Arduino's sketch compilation GitHub Actions actions have been moved to dedicated repositories and the copies left behind in the experimental arduino/actions repository deprecated.
…flow Even though the default artifact name is in use, reliance on this default is perhaps a bit more prone to issues.
aentinger
approved these changes
Feb 4, 2021
Merged
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.
Some advancements have been made in the GitHub Actions actions and workflows used by this repository since the time the CI system was originally set up. This PR brings them back to state of the art status again.