Skip to content

chore: bump clang-tools default version to 18 #73

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

Merged
merged 1 commit into from
Jul 1, 2025
Merged

Conversation

shenxianpeng
Copy link
Collaborator

@shenxianpeng shenxianpeng commented Jul 1, 2025

Summary by CodeRabbit

  • Documentation

    • Updated the README to reference version 18 of clang-format and clang-tidy in configuration examples.
  • Chores

    • Changed the default clang tool version from 16 to 18.
    • Updated tests to use version 18 instead of 16 for clang tool validation.

@shenxianpeng shenxianpeng added the enhancement New feature or request label Jul 1, 2025
Copy link

coderabbitai bot commented Jul 1, 2025

Walkthrough

The changes update the default Clang tool version from "16" to "18" across the documentation, utility constants, and test parameters. All references to version "16" are replaced with "18" to ensure consistency in usage examples, default behaviors, and test coverage.

Changes

File(s) Change Summary
README.md Updated example configurations to use Clang version "18" instead of "16".
cpp_linter_hooks/util.py Changed DEFAULT_CLANG_VERSION constant from "16" to "18".
tests/test_util.py Updated test parameterization to use Clang version "18" instead of "16".

Possibly related PRs

Suggested labels

minor


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c1fb2f3 and 6cc63c4.

📒 Files selected for processing (3)
  • README.md (2 hunks)
  • cpp_linter_hooks/util.py (1 hunks)
  • tests/test_util.py (1 hunks)
🔇 Additional comments (4)
cpp_linter_hooks/util.py (1)

13-13: Confirm clang-tools version 18 support

  • Verified that clang-tools-pip supports versions 8–20.
  • Version 18 is available on Linux, Windows, and macOS.

No further changes required.

tests/test_util.py (1)

9-9: LGTM! Test parameter update is consistent with the default version change.

The test parameterization correctly reflects the new default version, ensuring test coverage for version 18.

README.md (2)

55-55: LGTM! Documentation examples consistently updated.

The version specifications in the configuration examples are correctly updated from 16 to 18, maintaining consistency with the code changes.

Also applies to: 57-57


69-69: LGTM! Performance configuration examples also updated consistently.

The version specifications in the performance-focused configuration examples are correctly updated to match the new default version.

Also applies to: 72-72

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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 documentation Improvements or additions to documentation label Jul 1, 2025
Copy link

sonarqubecloud bot commented Jul 1, 2025

Copy link

codecov bot commented Jul 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.71%. Comparing base (c1fb2f3) to head (6cc63c4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #73   +/-   ##
=======================================
  Coverage   85.71%   85.71%           
=======================================
  Files           3        3           
  Lines          77       77           
=======================================
  Hits           66       66           
  Misses         11       11           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@shenxianpeng shenxianpeng merged commit 9e705e5 into main Jul 1, 2025
15 checks passed
@shenxianpeng shenxianpeng deleted the bump-version branch July 1, 2025 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant