aws / aws/amazon-documentdb-odbc-driver

Enable clang-tidy-review check in linux github action

Open
#169 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
6
Forks
2
PR merge metrics
No merged PRs in 30d

Description

`clang-tidy-check` fails due to errors that shouldn't be a problem for our code. For example, even with compile_commands.json generated, `clang-tidy-check` still is unable to find `boost/optional.hpp`, which might be due to boost being outside of our project root folder. There might be more errors beside that.
Reference to `clang-tidy-check` [error](https://github.com/aws/amazon-documentdb-odbc-driver/runs/6219998125?check_suite_focus=true#step:16:70):

AC:

- enable clang-tidy-check inside github workflow.
- [optional] create a test PR with minor code/comment changes to see that clang-tidy-check does not fail

Contributor guide

Open the contributing guide

Research direction

Start with the Linux GitHub workflow and the existing clang-tidy-check configuration, then inspect how compile_commands.json and the external Boost headers are made available. Run the clang-tidy-check to identify all remaining errors; done means the check is enabled and passes, with an optional test PR confirming minor code or comment changes do not fail it.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, github-actions
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.