search

pazi88 / STM32_CAN

CAN bus Library for Arduino STM32
GNU General Public License v3.0
68 stars 30 forks source link

Bugfix for example folder and CI by compiling examples, spell and lint check. #6

Closed designer2k2 closed 1 year ago

designer2k2 commented 1 year ago

Hello, thanks for this Library, i use it in some projects and it works great for me!

There is a small bug with the example folder, it has to be lowercase. This is the major change on this PR, making the example folder lowercase.

Further there is no CI here, so maybe this can help you?

This PR brings github actions that runs on every push or pull request. It takes the current state of the repository and compiles every example. It is done using the official arduino "compile-sketch" action: https://github.com/arduino/compile-sketches It is a minimalistic setup as it compiles only for the Nucleo 144 board. For that it always uses the latest stm32duino. If all examples compiled without error, its considered passing.

Also it does a spell check with the help from Codespell: https://github.com/codespell-project/actions-codespell

And last it check the complete library with the arduino lint tool, that checks if it complies with the arduino library reference: https://github.com/arduino/arduino-lint-action

This PR also fixes the detected issues by this checks, so everything passes.

pazi88 commented 1 year ago

Thanks for this PR. Seems that I had some stupid spelling errors etc. there that I have never noticed myself.