cmake-format lint action

Checks or formats CMake-specific files using cmake-format. To control the style of formatting, make sure to add a configuration file to the root of your project. For details on how to do this, see Configuration.

By default, the action checks formatting, fails the CI job if a file is not properly formatted, and prints a unified diff showing the required changes. Pass --in-place if you want the action to rewrite files instead.

Note: The current version of this action will process all CMakeLists.txt and *.cmake files in your project. If you require finer granularity, please request this feature (or any other features) by creating an Issue on the repository page.

Usage

To use this action, pass arguments to the args element as you would to cmake-format. Unless you pass a write option such as --in-place, the action will run in check mode and fail if formatting changes are needed. For example

  - name: Check CMake formatting
    id: cmake-format
    uses: puneetmatharu/cmake-format-lint-action@v1.0.8
    with:
      args: --config-files .cmake-format.json

      # Regex to select which files to apply cmake-format on.
      #
      # Defaults to '(.*\.cmake$|CMakeLists.txt$)'
      file-regex: '(.*\.cmake$|.*\.cmake\.in$|CMakeLists.txt$)'

If you want the action to rewrite files in-place, pass --in-place. For example:

  - name: Format CMake files
    id: cmake-format
    uses: puneetmatharu/cmake-format-lint-action@v1.0.8
    with:
      # Arguments to be passed to cmake-format.
      #
      # Options:
      #   -h, --help            show this help message and exit
      #   -v, --version         show program's version number and exit
      #   -l {error,warning,info,debug}, --log-level {error,warning,info,debug}
      #   --dump-config [{yaml,json,python}]
      #                         If specified, print the default configuration to stdout and exit
      #   --dump {lex,parse,parsedb,layout,markup}
      #   --no-help             When used with --dump-config, will omit helptext comments in the output
      #   --no-default          When used with --dump-config, will omit any unmodified configuration value.
      #   -i, --in-place
      #   --check               Exit with status code 0 if formatting would not change file contents, or status code 1 if it would
      #   -o OUTFILE_PATH, --outfile-path OUTFILE_PATH
      #                         Where to write the formatted file. Default is stdout.
      #   -c CONFIG_FILES [CONFIG_FILES ...], --config-files CONFIG_FILES [CONFIG_FILES ...]
      #                         path to configuration file(s)
      args: --config-files .cmake-format.json --in-place

      # Regex to select which files to apply cmake-format on.
      #
      # Defaults to '(.*\.cmake$|CMakeLists.txt$)'
      file-regex: '(.*\.cmake$|.*\.cmake\.in$|CMakeLists.txt$)'

If you want formatting changes to be written back to the repository, you will probably want to pair this with a GitHub Action (such as stefanzweifel/git-auto-commit-action) to commit any modified files. For example:

name: Run cmake-format linter

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Format CMake files
      id: cmake-format
      uses: puneetmatharu/cmake-format-lint-action@v1.0.8
      with:
        args: --config-files .cmake-format.json --in-place
        file-regex: '(.*\.cmake$|.*\.cmake\.in$|CMakeLists.txt$)'

    - name: Commit changes
      uses: stefanzweifel/git-auto-commit-action@v5
      with:
        commit_user_name: cmake-format-bot
        commit_message: 'Automated commit of cmake-format changes.'

Licence

The files distributed with this Action are provided under the blanket of an MIT licence.