Skip to content

Commit 85799d6

Browse files
authored
Merge pull request #120 from m-kuhn/patch-1
Add a hint for generating the compile command outside the container
2 parents b719737 + 65fbe78 commit 85799d6

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ at once, so `clang-tidy-review` will only attempt to post the first
122122

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

125-
## Generating `compile_commands.json` inside the container
125+
## Generating `compile_commands.json`
126126

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

160+
You can also generate this file outside the container, e.g. by adding
161+
`-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` to a cmake command in an earlier
162+
action and omitting the `cmake_command` paramter.
163+
160164
## Use in a non-default location
161165

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

0 commit comments

Comments
 (0)