Create GitHub Actions action to run Arduino Lint #1
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
In the event of a false positive, the problematic word should be added, in all lowercase, to the `ignore-words-list` field in ./.codespellrc.
This project is forked from arduino/setup-arduino-cli
This information is of no interest to the user, and thus having it in the user-targeted readme will only have a harmful effect.
Use a pure YAML formatting style, rather than a mixture of YAML and JSON styles.
This allows the CI system to benefit from ongoing improvements to the actions/setup-node GitHub Actions action, while avoiding breaking changes.
Unlike the `arduino/setup-arduino-cli` action this was based on, this is a standalone action. So adding the installation to the system path would only serve to pollute the runner environment.
Recommended practice for GitHub Actions (https://help.github.com/en/actions/building-actions/about-actions#versioning-your-action) is to add a ref to the repository for the major version, then update that ref on each release of that major version series. This allows users of the action to configure their workflows to use the latest version of the action that won't introduce breaking changes. Without this ref, the only options are: - pin a fixed ref - this means either frequent maintenance of the workflow to keep it up to date, or more likely using an outdated version of the action. - reference the tip of the default branch, subjecting the workflow to an unstable version of the action which may introduce bugs or breaking changes at any moment Although GitHub recommends using a tag, my understanding is that it's not considered best practices to alter Git tags. For this reason, I prefer using branch instead of a tag. There is no difference between the two as far as the usage of the action in a GitHub Workflow is concerned. The commits would be pushed to the branch on every release. I see GitHub even took the branch approach in one of the official actions: https://github.com/octokit/request-action Another prominent action using this approach: https://github.com/ruby/setup-ruby And our own (admittedly, I did it): https://github.com/arduino/setup-protoc
Otherwise, checkout converts the LF line endings to CRLF on the Windows runner, causing the formatting check to fail.
It's best practices to use release versions of the actions unless there is a compelling reason to do otherwise.
silvanocerza
approved these changes
Jan 12, 2021
per1234
added
topic: code
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
No description provided.