search

ErickSimoes / Ultrasonic

Minimalist library for Ultrasonic Module HC-SR04, PING))) and Seeed SEN136B5B to Arduino
MIT License
137 stars 65 forks source link

[CI] Workflow to Check Arduino Examples #65

Closed SteffanoP closed 3 years ago

SteffanoP commented 3 years ago

Summary

This Pull Request creates a new Compile Action to the workflow of Ultrasonic.

Description of the Change

This implementation aggregates linting to a new job, instead of a single workflow, therefore, it is refactored to a new workflow called Check Arduino which has 2 jobs called lint and compile.

For now, the compile job works in a matrix in the following boards: [arduino-uno, arduino-mega, arduino-leonardo].

Benefits

Workflow Actions help maintainers to keep their code as best as possible. This workflow action helps the maintainer knows how new implementations works in different Arduino Platforms and also compile testing with different examples.

Possible Drawbacks

If there's a major refactor or change in the code, this action may not result in a faithful result, therefore, it is advised to not use this action when there's a breaking change.

Verification Process

All of the works and testing was made on the main branch of my fork, there's also the workflow from my fork.

SteffanoP commented 3 years ago

@Maintainers, feel free to comment if there's a platform that you like to see to be compiled in the workflow.