Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a hint for generating the compile command outside the container #120

Merged
merged 1 commit into from
May 13, 2024
Merged

Add a hint for generating the compile command outside the container #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,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 @@ -158,6 +158,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