Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI checks #11

Open
DNedic opened this issue Dec 13, 2024 · 4 comments
Open

Add CI checks #11

DNedic opened this issue Dec 13, 2024 · 4 comments
Assignees

Comments

@DNedic
Copy link
Member

DNedic commented Dec 13, 2024

In order to avoid introducing regressions, either functional, style or policy we should consider adding a CI pipeline.

Some things we could add to the CI:

  1. Make sure our firmware builds
  2. Make sure we don't introduce any sources with incompatible licenses or forget to add license notices
  3. Enforce formatting rules
  4. Possibly run static analysis and/or other tools to find issues
@mileticveljko
Copy link
Contributor

Do you think GitHub Actions meets our requirements?

Perhaps this Issue can include adding Cmake target for code formatting and possibly for adding license notice to source files without one - so that process is automated for developers.

@DNedic
Copy link
Member Author

DNedic commented Dec 15, 2024

Usually this process is automated outside of the build system, using tools like pre-commit (see example here) and I do think we should add this as well.

@mileticveljko mileticveljko self-assigned this Dec 15, 2024
@mileticveljko mileticveljko moved this from Todo to In Progress in Project planning Dec 20, 2024
@DNedic
Copy link
Member Author

DNedic commented Dec 29, 2024

Code formatting and pre-commit hook is added here, if/when merged, we should add a GitHub workflow to run pre-commit hooks in the CI.

@mileticveljko
Copy link
Contributor

mileticveljko commented Jan 9, 2025

GitHub action that runs pre-commit in CI added. PR: #22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

No branches or pull requests

2 participants