GitHub Action for clang-format
checks. Note that this Action does NOT format your code for you - it only verifies that your repository's code follows your project's formatting conventions.
You can define your own formatting rules in a .clang-format
file at your repository root, or you can provide a fallback style (see fallback-style
). You can also provide a path to check. If you want to run checks against multiple paths in your repository, you can use this Action in a matrix run.
- 3:
clang-format-3.9
- 4:
clang-format-4.0
- 5:
clang-format-5.0
- 6:
clang-format-6.0
- 7:
clang-format-7
- 8:
clang-format-8
- 9:
clang-format-9
- 10:
clang-format-10
- 11:
clang-format-11
- 12:
clang-format-12
- 13:
clang-format-13
- 14:
clang-format-14
- 15:
clang-format-15
- 16:
clang-format-16
You can sponsor me here!
clang-format-version
[optional]: The major version ofclang-format
that you want to run on your codebase.- Default:
13
- Available versions: see Versions supported
- Default:
check-path
[optional]: The path to the directory in the repo that should be checked for C/C++/Protobuf formatting.- Default:
.
- For cleaner output (i.e. with no double-slashed paths), the final directory in this path should have no trailing slash, e.g.
src
and notsrc/
.
- Default:
fallback-style
[optional]: The fallback style forclang-format
if no.clang-format
file exists in your repository.- Default:
llvm
- Available values:
LLVM
,Google
,Chromium
,Mozilla
,WebKit
and others listed in theclang-format
docs for BasedOnStyle.
- Default:
exclude-regex
[optional]: A regex to exclude files or directories that should not be checked.- Default:
^$
- Pattern matching is done with a POSIX
grep -E
extended regex, not a glob expression. You can exclude multiple patterns like this:(hello|world)
. Build and verify your regex at https://regex101.com .
- Default:
include-regex
[optional]: A regex to include files or directories that should be checked.- Default:
^.*\.((((c|C)(c|pp|xx|\+\+)?$)|((h|H)h?(pp|xx|\+\+)?$))|(ino|pde|proto|cu))$
- Pattern matching is done with a POSIX
grep -E
extended regex, not a glob expression. You can exclude multiple patterns like this:(hello|world)
. Build and verify your regex at https://regex101.com .
- Default:
This action checks all C/C++/Protobuf (including Arduino .ino
and .pde
) files in the provided directory in the GitHub workspace are formatted correctly using clang-format
. If no directory is provided or the provided path is not a directory in the GitHub workspace, all C/C++/Protobuf files are checked.
The following file extensions are checked by default:
- Header files:
.h
.H
.hpp
.hh
.h++
.hxx
- Source files:
.c
.C
.cpp
.cc
.c++
.cxx
.ino
.pde
.cu
- Protobuf files:
.proto
- SUCCESS: zero exit-code if C/C++/Protobuf files in
check-path
are formatted correctly - FAILURE: nonzero exit-code if C/C++/Protobuf files in
check-path
are not formatted correctly
windows
GitHub Actions runners!
To use this action, create a .github/workflows/clang-format-check.yml
in your repository containing:
name: clang-format Check
on: [push, pull_request]
jobs:
formatting-check:
name: Formatting Check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Run clang-format style check for C/C++/Protobuf programs.
uses: jidicula/[email protected]
with:
clang-format-version: '13'
check-path: 'src'
fallback-style: 'Mozilla' # optional
To use this action on multiple paths in parallel, create a .github/workflows/clang-format-check.yml
in your repository containing:
name: clang-format Check
on: [push, pull_request]
jobs:
formatting-check:
name: Formatting Check
runs-on: ubuntu-latest
strategy:
matrix:
path:
- 'src'
- 'examples'
steps:
- uses: actions/checkout@v3
- name: Run clang-format style check for C/C++/Protobuf programs.
uses: jidicula/[email protected]
with:
clang-format-version: '13'
check-path: ${{ matrix.path }}
fallback-style: 'Mozilla' # optional
To use this action on multiple paths in parallel with exclusions, create a .github/workflows/clang-format-check.yml
in your repository containing:
name: clang-format Check
on: [push, pull_request]
jobs:
formatting-check:
name: Formatting Check
runs-on: ubuntu-latest
strategy:
matrix:
path:
- check: 'src'
exclude: '(hello|world)' # Exclude file paths containing "hello" or "world"
- check: 'examples'
exclude: '' # Nothing to exclude
steps:
- uses: actions/checkout@v3
- name: Run clang-format style check for C/C++/Protobuf programs.
uses: jidicula/[email protected]
with:
clang-format-version: '13'
check-path: ${{ matrix.path['check'] }}
exclude-regex: ${{ matrix.path['exclude'] }}
fallback-style: 'Mozilla' # optional
These public repos use this Action.