GitHub Workflow

[ReidP-source]

Chet has requested we setup an actions workflow similar to what ear2earth has...

Embedded C++ has some additional steps that will need to be considered before implementing a full workflow. We should start small with a Linter and Formatting then work towards adding tests.

Formatting:
clang-format

https://en.wikipedia.org/wiki/Programming_style

• Essential for maintaining a consistent format across many modules.

Linter:
clang-tidy

https://en.wikipedia.org/wiki/Lint_%28software%29

• Identifies possible bugs, suspicious constructs, errors, and style issues automatically.

Tutorial for VScode:
https://www.davidampurua.com/posts/how-to-implement-linter-c/

Tutorial for GitHub Actions:
https://github.com/cpp-linter/cpp-linter-action

Chimes Web workflow example:
https://github.com/OPEnSLab-OSU/WeatherChimesWeb/blob/main/.github/workflows/ci.yml

Linting PP with CCstudio by Texas Instruments:
https://www.ti.com/lit/ml/sprp582/sprp582.pdf?ts=1767649662085&ref_url=https%253A%252F%252Fwww.google.com%252F

• Code Composer has built-in git integration but it's a whole new IDE.

[ReidP-source]

Arduino Git Actions Blog:
https://blog.arduino.cc/2021/04/09/test-your-arduino-projects-with-github-actions/

[ReidP-source]

Adafruit Arduino CI

https://github.com/adafruit/ci-arduino

https://github.com/adafruit/Adafruit_ADS1X15/blob/master/.github/workflows/githubci.yml