header file not found

[2bndy5]

I see. Thanks for answer. Thanks for this action and your time to support!

Meanwhile, I run into another issue with regard to clang tidy's database (I'm not sure to open another issue - it's at yours). My action looks like

    - name: clang-format & clang-tidy
      uses: cpp-linter/cpp-linter-action@v1.4.2
      id: linter
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        style: file
        version: 14
        # directory containing compilation database (compile_commands.json)
        database: build/ci-linux-clang
        # don't use action's default
        tidy-checks: ''

where CMakePresets.json contains

    ...
    "configurePresets": [
        {
            "name": "use-ninja",
            "generator": "Ninja",
            "cacheVariables": { "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" }
        },
        {
            "name": "default-dirs",
            "binaryDir": "${sourceDir}/build/${presetName}",
            ...
        },
    ...

The action's log shows that it fails:

Run cpp-linter/cpp-linter-action@v1.4.2
/usr/bin/docker run --name f1554a9d49084b68a4119971e2b6f8bf850d2_02701c --label 6f1554 --workdir /github/workspace --rm -e CONAN_V2_MODE -e GITHUB_TOKEN -e INPUT_STYLE -e INPUT_VERSION -e INPUT_DATABASE -e INPUT_TIDY-CHECKS -e INPUT_THREAD-COMMENTS -e INPUT_EXTENSIONS -e INPUT_REPO-ROOT -e INPUT_VERBOSITY -e INPUT_LINES-CHANGED-ONLY -e INPUT_FILES-CHANGED-ONLY -e INPUT_IGNORE -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_RUN_ATTEMPT -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_REF_NAME -e GITHUB_REF_PROTECTED -e GITHUB_REF_TYPE -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e GITHUB_STEP_SUMMARY -e RUNNER_OS -e RUNNER_ARCH -e RUNNER_NAME -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/gh-actions-test/gh-actions-test":"/github/workspace" 6f1554:a9d49084b68a4119971e2b6f8bf850d2  "--style=file" "--extensions=c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx" "--tidy-checks=" "--repo-root=." "--version=14" "--verbosity=10" "--lines-changed-only=false" "--files-changed-only=true" "--thread-comments=false" "--ignore=.github" "--database=build/ci-linux-clang"
INFO:CPP Linter:Ignoring the following paths/files:
	./.github
INFO:CPP Linter:processing push event
Event json from the runner
Get list of specified source files
Performing checkup on source/main.cpp
  INFO:CPP Linter:Running "clang-tidy-14 --export-fixes=clang_tidy_output.yml -p /home/runner/work/gh-actions-test/build/ci-linux-clang source/main.cpp"
  DEBUG:CPP Linter:Output from clang-tidy:
  /github/workspace/source/main.cpp:4:10: error: 'fmt/format.h' file not found [clang-diagnostic-error]

Otherwise, running VS Code's devcontainer shows relative path seems to work:

vscode ➜ /workspaces/gh-actions-test (main ✗) $ clang-tidy-14 --export-fixes=clang_tidy_output.yml -p build/ci-linux-clang source/main.cpp
68700 warnings generated.
Suppressed 68700 warnings (68698 in non-user code, 2 with check filters).
Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.

I haven't the experience with clang-tidy using CLI arguments and python, so my guess is that's there is a wrong path (otherwise not very likely) :(

If relevant, the action is here

Originally posted by @ibis-hdl in #64 (comment)

[2bndy5]

Thanks for the link to the actual repo/workflow, that is most helpful! With that said, your extensive CMake presets are a bit difficult to follow for such a simple test.

There may be a problem with docker file system not seeing fmt/format.h in the runner's file system.

If you need to use a custom env (typically for non-std libs or cross-compiling), then I'd recommend trying the windows example workflow in the readme. You don't need to use windows, you just need to understand how to use this action's source as a python installable package. I put together an example based on the snippet you posted in the OP:

on:
  pull_request:
    types: [opened, reopened]  # let PR-synchronize events be handled by push events
  push:

jobs:
  cpp-linter:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v3

      - name: Install clang-tools
        uses: KyleMayes/install-llvm-action@v1
        with:
          version: 14
          # specifying an install path is not required for ubuntu
          # directory: ${{ runner.temp }}/llvm

      - name: Install linter python package
        run: python3 -m pip install git+https://github.com/cpp-linter/cpp-linter-action@v1

      - name: run linter as a python package
        id: linter
        run: cpp-linter --version=14 --style=file --tidy-checks='' --database=build/ci-linux-clang

      - name: Fail fast?!
        if: steps.linter.outputs.checks-failed > 0
        run: echo "Some files failed the linting checks!"
        # for actual deployment
        # run: exit 1

[2bndy5]

BTW, that conan pkg mgr is a cool tool. Thanks for the lead on that!

[2bndy5]

@ibis-hdl Don't forget the step that installs LLVM:

      - name: Install clang-tools
        uses: KyleMayes/install-llvm-action@v1
        with:
          version: 14

This is important because you're not using the docker container for this action since you changed to using this action's python source code on the runner file system.

[ibis-hdl]

@ibis-hdl Don't forget the step that installs LLVM:

      - name: Install clang-tools
        uses: KyleMayes/install-llvm-action@v1
        with:
          version: 14

This is important because you're not using the docker container for this action since you changed to using this action's python source code on the runner file system.

Thanks, even I use Ubuntu-22.04 which has bundled clang-14 (and which seems to work)??

jobs:
  cpp-linter:
    runs-on: ubuntu-22.04
    steps:
    - name: Install basic dependencies
      run: |
        sudo apt-get update
        sudo apt-get install --no-install-recommends -y cmake ninja-build ccache clang-14 clang-format clang-tidy

Anyway, I've changed the action to use the installable package a121d28 and run into same issue:

Run cpp-linter --version=14 --style=file --tidy-checks='' --ignore=build --database=build/ci-linux-clang
  cpp-linter --version=14 --style=file --tidy-checks='' --ignore=build --database=build/ci-linux-clang
  shell: /usr/bin/bash -e {0}
  env:
    CONAN_V2_MODE: 1
INFO:CPP Linter:Ignoring the following paths/files:
	./build
INFO:CPP Linter:processing push event
Event json from the runner
Get list of specified source files
  DEBUG:CPP Linter:Crawling "./"
  DEBUG:CPP Linter:Crawling "./scripts"
  DEBUG:CPP Linter:Crawling "./build"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/bin"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/CMakeFiles"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/CMakeFiles/3.23.2"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/CMakeFiles/3.23.2/CompilerIdCXX"
  DEBUG:CPP Linter:"./build/ci-linux-clang/CMakeFiles/3.23.2/CompilerIdCXX/CMakeCXXCompilerId.cpp" is a source code file
  DEBUG:CPP Linter:"./build/ci-linux-clang/CMakeFiles/3.23.2/CompilerIdCXX/CMakeCXXCompilerId.cpp" is ignored as specified in the domain "./build"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/CMakeFiles/3.23.2/CompilerIdCXX/tmp"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/CMakeFiles/CMakeTmp"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/source"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/source/CMakeFiles"
  DEBUG:CPP Linter:Crawling "./build/ci-linux-clang/source/CMakeFiles/github-action.dir"
  DEBUG:CPP Linter:Crawling "./source"
  DEBUG:CPP Linter:"./source/main.cpp" is a source code file
  INFO:CPP Linter:Giving attention to the following files:
  	source/main.cpp
Performing checkup on source/main.cpp
  INFO:CPP Linter:Running "clang-tidy-14 --export-fixes=clang_tidy_output.yml -p /home/runner/work/gh-actions-test/build/ci-linux-clang source/main.cpp"
  DEBUG:CPP Linter:Output from clang-tidy:
  /home/runner/work/gh-actions-test/gh-actions-test/source/main.cpp:4:10: error: 'fmt/format.h' file not found [clang-diagnostic-error]
  #include <fmt/format.h>
           ^~~~~~~~~~~~~~
....

I'm also confused about Linter:Ignoring the following paths/files: ./build and than Linter:Crawling "./build ..."

[2bndy5]

Oh I didn't see that step in your workflow (hidden in the diff).

I'm also confused about Linter:Ignoring the following paths/files: ./build and than Linter:Crawling "./build ..."

TL;DR don't worry about that.

The debug statement is just telling me what folders it is crawling. In this instance it is actually looking for files that were explicitly not ignored with the ignored parent folder...

Anyway, I've changed the action to use the installable package a121d28 and run into same issue:

Believe it or not I think we're getting closer to solving this. Now that you've got the action running in your runner's File system, it is just a matter of making sure clang-tidy knows where to look for fmt/format.h. So, here's where I have to ask some very project specific questions (thankfully your project is a test bed).

1. Where is conan putting fmt/format.h?
2. Is the path to fmt in your compilation database (generated by cmake)?

[ibis-hdl]

Believe it or not I think we're getting closer to solving this. Now that you've got the action running in your runner's File system, it is just a matter of making sure clang-tidy knows where to look for fmt/format.h. So, here's where I have to ask some very project specific questions (thankfully your project is a test bed).

1. Where is conan putting fmt/format.h?

2. Is the path to fmt in your compilation database (generated by cmake)?

Conan builds the binaries and installs them into an own directory, e.g. on Linux

$  conan info . --paths
...
    export_folder: /home/vscode/.conan/data/fmt/8.1.1/_/_/export
    source_folder: /home/vscode/.conan/data/fmt/8.1.1/_/_/source
    build_folder: /home/vscode/.conan/data/fmt/8.1.1/_/_/build/2c09c8f84c016041549fcee94e4caae5d89424b6
    package_folder: /home/vscode/.conan/data/fmt/8.1.1/_/_/package/2c09c8f84c016041549fcee94e4caae5d89424b6
...

using conan.cmake one is able to use the generated CMake Find... (concrete Findfmt.cmake here) commands to build the project as usual by setting project's

target_include_directories(${PROJECT_NAME}
    PUBLIC
        $<INSTALL_INTERFACE:include>
    PRIVATE
        $<BUILD_INTERFACE:${fmt_INCLUDE_DIR}>
)

which explains, why the CMake's generated compile_commands.json is required for Clangs's tooling - and here we are :)

compile_commands.json:

[
{
  "directory": "/workspaces/gh-actions-test/build/ci-linux-clang",
  "command": "/usr/bin/clang++ -I/workspaces/gh-actions-test/source -isystem /home/vscode/.conan/data/fmt/8.1.1/_/_/package/4539af7a6a16a6e8e29b0d4718fe4601b7500274/include -O3 -DNDEBUG -std=c++20 -o source/CMakeFiles/github-action.dir/main.cpp.o -c /workspaces/gh-actions-test/source/main.cpp",
  "file": "/workspaces/gh-actions-test/source/main.cpp"
}
]

It seems to me that this isn't found or even not used; otherwise it would find the include/lib directories.

[2bndy5]

I'm trying to build your project locally, but the CMake setup is so complex that I'm having trouble.

I did notice a rather slight difference between the example in the conan README and your project's target_include_directories() call:

find_package(fmt CONFIG)
add_executable(main main.cpp)
target_link_libraries(main fmt::fmt)

whereas you're using

target_include_directories(${PROJECT_NAME}
    PUBLIC
        $<INSTALL_INTERFACE:include>
    PRIVATE
        $<BUILD_INTERFACE:${fmt_INCLUDE_DIR}>
)

I don't really use CMake's generator statements, so I don't know what $<BUILD_INTERFACE:${fmt_INCLUDE_DIR}> resolves to.

I need to see exactly where conan is putting fmt lib (your answer wasn't very clear about that - IDK how to use/understand conan cmds).

[2bndy5]

ok I finally got cmake to generate successfully, and I ran clang-tidy without complaints. There must be something else going on with the CI runner... Still trying to figure this one out.

These are the cmds I ended up using:

source env/bin/activate
pip install conan cmake
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
clang-tidy ../source/main.cpp -p .