An action that check code format using clang-format tool. Suitable for project built on C, C++, C#, Objective-C.
Clang: a C language family frontend for LLVM
- It automatic checks the source file's code format, and if there is any code format violation, it exits with a nonzero status.
- Suggest commands for fixing the formation violated file.
Sources to check by this action. It can be a single file, regex of a folder or multiple selecteor seprated by comma (,).
Default: "**/*". That means all files in this repository.
Example: If your repository contains many files other than C file, you can try with specific extension like:
"src/*.h,src/*.c"
or, for all nested folder
"src/**/*.h,src/**/*.c"
The style for clang-format. Possible value are: LLVM, GNU, Google, Chromium, Microsoft, Mozilla, WebKit. If your repository has a .clang-format file in the root directory then you can use file option here.
Default: LLVM
Create a file in .github/workflows/ folder with:
name: Clang Format Checker
on: [push]
jobs:
clang-format-checking:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: RafikFarhad/clang-format-github-action@v1.0.1
with:
sources: "src/**/*.h,src/**/*.c,test/**/*.c"
It will check for code formation violation on every push to GitHub.
This action uses clang-format version 10.
Kudos to @silkeh for his awesome docker image.
Feel free to submit PR and/or raise issue.
🌞 Thanks for using 🌞