Skip to content

Commit

Permalink
Merge pull request #120 from m-kuhn/patch-1
Browse files Browse the repository at this point in the history
Add a hint for generating the compile command outside the container
  • Loading branch information
ZedThree committed May 13, 2024
2 parents b719737 + 65fbe78 commit 85799d6
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ at once, so `clang-tidy-review` will only attempt to post the first

- `total_comments`: Total number of warnings from clang-tidy

## Generating `compile_commands.json` inside the container
## Generating `compile_commands.json`

Very simple projects can get away without a `compile_commands.json`
file, but for most projects `clang-tidy` needs this file in order to
Expand Down Expand Up @@ -157,6 +157,10 @@ jobs:
If you don't use CMake, this may still work for you if you can use a
tool like [bear](https://github.com/rizsotto/Bear) for example.

You can also generate this file outside the container, e.g. by adding
`-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` to a cmake command in an earlier
action and omitting the `cmake_command` paramter.

## Use in a non-default location

If you're using the `container` argument in your GitHub workflow,
Expand Down

0 comments on commit 85799d6

Please sign in to comment.