clang-format-action

GitHub Action for clang-format

This action checks all C files (.c and .h) in the GitHub workspace are formatted correctly using the precompiled Python wheel for clang-format.

The action returns:

• SUCCESS: zero exit-code if project C files are formatted correctly
• FAILURE: nonzero exit-code if project C files are not formatted correctly

Define your own formatting rules in a .clang-format file at your repository root. Otherwise, the LLVM style guide is used as a default. My preference is the Linux Project format.

Usage

To use this action, create a .github/workflows/clang-format-check.yml in your repository containing:

name: clang-format Check
on: [push]
jobs:
  formatting-check:
    name: Formatting Check
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Run clang-format style check for C programs.
      uses: jidicula/clang-format-action@master