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

chore: Fix clang-tidy config file format #4062

Merged
merged 4 commits into from
Jan 31, 2025

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Jan 30, 2025

This PR fixes the format of the .clang-tidy and removes the separate configuration layer that we were using for the CI run of clang-tidy.

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

  • Configuration

    • Updated .clang-tidy configuration to use a more readable multiline format.
    • Added header file filtering for static analysis checks.
    • Simplified CMake static analysis configuration by removing explicit check and error lists.
  • Maintenance

    • Streamlined clang-tidy setup process.
    • Reduced configuration complexity for static code analysis.

@paulgessinger paulgessinger added this to the next milestone Jan 30, 2025
Copy link

coderabbitai bot commented Jan 30, 2025

Walkthrough

Changes to static analysis configuration, there are. The .clang-tidy file, reformatted it was, using YAML's multiline string syntax. In the CMake file, clang-tidy configuration simplified, it has been. Checks and error handling, removed they were, leaving a more streamlined approach to code analysis.

Changes

File Change Summary
.clang-tidy Multiline string syntax updated for Checks entry, HeaderFilterRegex added to target specific header files
cmake/ActsStaticAnalysis.cmake Removed complex check and error configuration, simplified clang-tidy command to use only header filter

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • AJPfleger

Poem

Static checks, a Jedi's might,
Code flows clean, pure and bright.
Clang-tidy trims the excess code,
Wisdom in each parsed abode. 🧘‍♂️🔍


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the Infrastructure Changes to build tools, continous integration, ... label Jan 30, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
cmake/ActsStaticAnalysis.cmake (1)

15-15: Suggest header filter refinement, I must.

Consider restricting header filter pattern more specifically, we should. Currently matches all files with ".*", it does.

Apply this change, you might:

-set(CLANG_TIDY_HEADER_FILTER ".*")
+set(CLANG_TIDY_HEADER_FILTER "^.*/(Core|Detector|EventData|Geometry|MagneticField|Material|Propagator|Surfaces|Utilities)/.*\.hpp$")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3c160b and 719337d.

📒 Files selected for processing (1)
  • cmake/ActsStaticAnalysis.cmake (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: CI Bridge / linux_ubuntu_2204_clang
  • GitHub Check: CI Bridge / linux_ubuntu_2204
  • GitHub Check: CI Bridge / build_linux_ubuntu
  • GitHub Check: CI Bridge / build_exatrkx
  • GitHub Check: CI Bridge / build_exatrkx_cpu
  • GitHub Check: CI Bridge / clang_tidy
  • GitHub Check: macos
🔇 Additional comments (1)
cmake/ActsStaticAnalysis.cmake (1)

15-15: Approve the simplified configuration approach, I do.

Wise decision it is, to move clang-tidy configuration to external file. Cleaner and more maintainable, the code becomes. Standard practice in the industry, this approach is.

Verify the existence of configuration file, we must. Run this command, you shall:

✅ Verification successful

Verified, the configuration file is. Proceed with confidence, you may.

Found and valid, the .clang-tidy file is. In proper YAML format, it exists. Successful, the migration to external configuration has been.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify .clang-tidy file exists and is properly formatted

if [ -f ".clang-tidy" ]; then
    echo "Found .clang-tidy file"
    # Verify YAML syntax
    python3 -c 'import yaml, sys; yaml.safe_load(sys.stdin)' < .clang-tidy && echo "YAML syntax valid"
else
    echo "ERROR: .clang-tidy file not found!"
    exit 1
fi

Length of output: 183

Copy link

github-actions bot commented Jan 30, 2025

📊: Physics performance monitoring for 88916cb

Full contents

physmon summary

Copy link
Contributor

@AJPfleger AJPfleger left a comment

Choose a reason for hiding this comment

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

Finally we have it 😍

@kodiakhq kodiakhq bot merged commit 284f7c1 into acts-project:main Jan 31, 2025
43 checks passed
@acts-project-service acts-project-service added the Fails Athena tests This PR causes a failure in the Athena tests label Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Fails Athena tests This PR causes a failure in the Athena tests Infrastructure Changes to build tools, continous integration, ...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants