Modernize spell checking infrastructure #382
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 repository contains a CI workflow to check for commonly misspelled words in the project files. This is done using the "codespell" tool. A GitHub Actions action handles the installation and execution of the tool. At the time Arduino started setting up such infrastructure in project repositories, no such action was available and so Arduino created an action. Since that time, the codespell developers created an equivalent action and so Arduino's action was abandoned. Most of the libraries were migrated to the new action, but somehow this repository is still using the abandoned action. Due to bit rot, Arduino's action now fails to initialize: ``` #8 [3/4] RUN pip3 install codespell #8 0.401 error: externally-managed-environment [...] ERROR: failed to solve: process "/bin/sh -c pip3 install codespell" did not complete successfully: exit code: 1 Error: Docker build failed with exit code 1 ``` The problem is solved by migrating the spell check workflow to using the codespell action.
The "codespell" spellchecker tool is used to automatically detect commonly misspelled words in the files of this project. The misspelled words dictionary was expanded in recent releases of codespell, which resulted in the detection of misspelled words in the project files: > Error: ./src/utility/HCI.cpp:761: Signalling ==> Signaling > Error: ./docs/readme.md:22: acknowledgement ==> acknowledgment The typos are hereby corrected, which will restore the spell check to a passing state. --- I supplemented the correction of the automatically detected typos with a general review of the project content, fixing the additional typos I identified during that review.
per1234
added
type: imperfection
|
Memory usage change @ 0178fdf
Click for full report table
Click for full report CSV |
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.
The repository contains a CI workflow to check for commonly misspelled words in the project files. This is done using the excellent codespell tool.
A GitHub Actions action handles the installation and execution of the tool. At the time Arduino started setting up such infrastructure in project repositories, no such action was available and so Arduino created an action. Since that time, the codespell developers created an equivalent action and so Arduino's action was abandoned (arduino/actions#101). Most of the libraries were migrated to the new action, but somehow this repository is still using the abandoned action. Due to bit rot, Arduino's action now fails to initialize:
https://github.com/arduino-libraries/ArduinoBLE/actions/runs/13144109589/job/36678058965?pr=381#step:2:977
The problem is solved by migrating the spell check workflow to using the codespell action.