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

ci: Add clang-format lint check #1510

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

antangelo
Copy link
Contributor

Checks formatting and lints for PR changes in CI, using this github action: https://github.com/marketplace/actions/c-c-linter

I left the default clang-tidy checks enabled, if this is undesirable they can be set to read from a .clang-tidy file, although there isn't one in the repo currently.

I've also set it to comment on the pull request thread with the results, so that they are more visible. However, this does introduce noise to the PR thread so I'm open to disabling it. In either case, it will comment on the most recent commit with the results.

Unfortunately there aren't many actions available to run clang-format on only the files changed in a PR from what I can find, and this one does not indicate the exact formatting errors that are found (only that the files are not formatted correctly).

A dummy PR with failing lints is available here: antangelo#3

@mborgerson
Copy link
Member

On first look I didn't like the reporting of the tool much (e.g. reporting failure without saying what specifically was wrong, soliciting feedback, etc). Apparently there is a feature now that can leave detailed code review comments at https://cpp-linter.github.io/cpp-linter-action/#only-clang-format. What do you think?

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

Successfully merging this pull request may close these issues.

2 participants