Skip to content

docs: explain include paths for third-party libraries and drop a private-repo claim #72

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

Merged
shenxianpeng merged 1 commit into from
Sep 30, 2026
Merged

docs: explain include paths for third-party libraries and drop a private-repo claim #72

Show file tree
Hide file tree
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
7 changes: 5 additions & 2 deletions docs/blog/posts/2026-09-20-clang-tidy-pull-requests-github-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,11 @@ language standard of the real build. It reads them from a compilation database,

Two things commonly go wrong here:

- **Third-party dependencies.** If the configure step runs `find_package(Foo)`, install
`libfoo-dev` (or restore your vcpkg/Conan cache) before it, exactly as your build job does.
- **Third-party libraries.** clang-tidy finds a library's headers only through the `-I` paths
the compiler gets for each file, and it reads those from the database. Install the library
before the configure step, as your build job does (`libfoo-dev`, or your vcpkg or Conan cache),
so `find_package(Foo)` succeeds and its include paths are recorded. Without a build system, add
the paths to `extra-args` yourself, for example `-Ithird_party/fmt/include`.
- **Generated headers.** Protobuf output, `config.h` and similar files only exist after the build
step that produces them. Build those targets before running clang-tidy.

Expand Down
2 changes: 1 addition & 1 deletion docs/overrides/home.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ <h3 class="cl-h3">Thread Comment</h3>
<h3 class="cl-h3">Step Summary</h3>
<code class="cl-inline-code">step-summary</code>
</div>
<p>Set step-summary: true and the same report is added to the job summary of the workflow run. It needs no write access, so it also works on pull requests from forks and in private repositories, where thread comments are turned off.</p>
<p>Set step-summary: true and the same report is added to the job summary of the workflow run. It needs no write access, so it also works on pull requests from forks.</p>
</article>
<article class="cl-outcome">
<div class="cl-outcome__art" aria-hidden="true">
Expand Down
Loading