Use GitHub Actions for CI #236
Commits on Oct 4, 2020
-
Add CI workflow to check for misspelled words
On every push and pull request, the files of the repository will be checked for commonly misspelled words using codespell. The workflow is also run weekly in order to catch new misspelled word detections that result from updates to the codespell dictionary. In the event of a false positive, add the word in all lower case to megaavr/extras/ci/codespell-ignore-words-list.txt
-
-
Add CI workflow to check structure of bundled libraries
This workflow checks for common issues with the structure of the platform bundled libraries.
-
Add CI workflow to check library.properties of bundled libraries
This workflow checks for common issues with the library.properties files of the platform bundled libraries.
-
Add CI workflow to check keywords.txt of bundled libraries
This workflow checks for common problems with the keywords.txt files of the platform bundled libraries.
-
Use correct field separator in keywords.txt
The Arduino IDE requires the use of a single true tab separator between the keyword name and identifier. When spaces are used rather than a true tab, the keyword is not highlighted. Reference: https://arduino.github.io/arduino-cli/latest/library-specification/#keywordstxt-format
-
Add CI workflow to check for UTF-8 BOM file encoding
Some low quality text editors may use this encoding by default. The invisible BOM character added to the first line can cause confusing errors.
-
Add CI check for files starting with a blank line
There is no reason for a file to ever start with a blank line, so adding one would only pollute the diff.
-
-
Add CI workflow to check for unnecessary use of true tabs
The code uses spaces for indentation.
-
-
-
-
-
-
-
-
-
-
-
Add CI workflow to compile example sketches
Example sketches of all bundled libraries are compiled for all boards of the platform.
-
Add a CI workflow to report memory usage change caused by PRs
On every push, change in memory usage is calculated and displayed in the workflow build log. A JSON format file containing this information as well as other data on the compilations is saved as a workflow log. The memory usage change report will be commented to the pull request thread.
-
Configure Compile Examples CI workflow to report changes in compiler …
…warning count The compiler warning count delta will be displayed in the workflow build log and in the workflow artifact files.
