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.

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

feat(clang-tidy): introducing .clang-tidy-ignore #326

Merged
merged 3 commits into from
Nov 28, 2024

Conversation

yhisaki
Copy link
Contributor

@yhisaki yhisaki commented Nov 27, 2024

Description

This PR introduces support for ignoring specific files in clang-tidy.
To achieve this, you can create a .clang-tidy-ignore file under your project directory and list file paths or regular expressions for the files you wish to ignore, as shown below:

*/examples/*
perception/**

Additionally, this PR includes minor changes.

  1. Use run-clang-tidy instead of clang-tidy.

    • run-clang-tidy allows for parallel execution of clang-tidy.
  2. Change the report file suffix from .txt to .log.

    • Most editors (e.g., VS Code) can colorize log files, enhancing their readability.

Related links

Tests performed

Tested in this Action.

Effects on system behavior

Not applicable.

Interface changes

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

clang-tidy/action.yaml Outdated Show resolved Hide resolved
clang-tidy/action.yaml Outdated Show resolved Hide resolved
clang-tidy/action.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@veqcc veqcc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
Please move on to @.xmfcx & @.mitsudome-r reviews.

clang-tidy/action.yaml Outdated Show resolved Hide resolved
Signed-off-by: Y.Hisaki <[email protected]>
@yhisaki yhisaki merged commit 196ca1d into autowarefoundation:main Nov 28, 2024
12 of 14 checks passed
@yhisaki yhisaki deleted the enhance-clang-tidy branch November 28, 2024 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants