Skip to content

Conversation

@shenxianpeng
Copy link
Contributor

@shenxianpeng shenxianpeng commented Sep 26, 2025

I’ve redistributed the clang-tools Python wheels to GitHub releases without making any changes upstream. The goal is to have the wheels readily available when needed, without having to wait for an upstream request—similar to what was done in ssciwr/clang-tidy-wheel#100 and ssciwr/clang-tidy-wheel#96

And maybe it can replace https://github.com/cpp-linter/clang-tools-static-binaries via clang-tools CLI in the future..

Summary by CodeRabbit

  • Documentation
    • Updated Clang Tools installation instructions to include Python wheel distribution as an option for easier installs.
    • Added a direct link to the clang-tools-wheel repository for quicker access and setup.
    • Clarified and streamlined installation steps for cross-platform environments.
    • No changes to runtime behavior, public APIs, or function signatures; documentation-only changes.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Sep 26, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the README to include the new clang-tools-wheel repository alongside existing clang-tools distribution methods. The update expands the available options for using clang tools by adding Python wheel distribution as an alternative to static binaries and Docker images.

  • Added reference to clang-tools-wheel repository in the documentation
  • Updated descriptive text to include "Python wheels" as a distribution method

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@coderabbitai
Copy link

coderabbitai bot commented Sep 26, 2025

Walkthrough

Updated profile/README.md to add Python wheel installation details for Clang Tools and link to the clang-tools-wheel repository. No code or API changes.

Changes

Cohort / File(s) Summary of Changes
Documentation
profile/README.md
Expanded “Clang Tools — Simplified installation” to include Python wheel distribution and added a link to the clang-tools-wheel repository.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly captures the primary change, namely updating README.md to include the new clang-tools-wheel distribution channel. It directly reflects the modification described in the pull request without extraneous detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch shenxianpeng-patch-1

📜 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 3d6fe8a and 7a4c49d.

📒 Files selected for processing (1)
  • profile/README.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • profile/README.md

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@2bndy5
Copy link
Contributor

2bndy5 commented Sep 26, 2025

I had a look at those packages. The CI uses qemu to properly cross-compile the binaries for distribution on PyPI 👍🏼 Indeed, this would be a good replacement for our faulty static binaries.

One thing I'd like to point out is that the history does not go back to clang v10. I think those clang-*-wheels projects only go back to v13.

@2bndy5
Copy link
Contributor

2bndy5 commented Sep 26, 2025

@shenxianpeng I think ssciwr/clang-tidy-wheel#100 can now be closed since the request release has been deployed.

@shenxianpeng shenxianpeng merged commit d18884a into main Sep 26, 2025
5 checks passed
@shenxianpeng shenxianpeng deleted the shenxianpeng-patch-1 branch September 26, 2025 07:36
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants