Skip to content

docs: use v1.8.0 and recommend additional_dependencies - #307

Merged
shenxianpeng merged 2 commits into
mainfrom
claude/project-thread-jz4xdm
Oct 23, 2026
Merged

shenxianpeng merged 2 commits into
mainfrom
claude/project-thread-jz4xdm

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

Prepares the docs for the v1.8.0 release, like #304 did for v1.7.0.

  • README and the CMake and Meson examples use rev: v1.8.0.
  • Quick start recommends pinning the wheel in additional_dependencies for teams, CI, and machines behind a firewall or a company PyPI mirror. pre-commit then installs the tool once, when it builds the hook environment, the same way mirrors-clang-format does.
  • The "Offline and pre-commit.ci" section is now "Install the tool with the hook" and covers those cases. It also notes that the pinned wheel must match --version.
  • The version notes say that parallel hook runs share one install (fix: install clang tools one hook process at a time #306).
  • The "Default Clang Tool Versions" header is removed from the release notes. It said the hook always uses the latest clang tool release, but since feat: use installed wheels offline, quieter clang-tidy output, repair split --checks #302 an installed wheel is reused and not upgraded. Without it, the release-drafter workflow calls the shared org workflow, like clang-tools-pip and cpp-linter-action.

The README already covers the #303 changes (only changed lines by default, --all-lines, no compilation database).

Point the README and examples at v1.8.0. Recommend pinning the clang
tool wheel in additional_dependencies, so pre-commit installs it once
with the hook, as mirrors-clang-format does, and note that parallel
hook runs install the wheel once.
The note said the hook always uses the latest clang tool release. Since
#302 an installed wheel is reused and not upgraded, so the note was wrong.
Without the note the workflow can call the shared org release-drafter
workflow, like the other cpp-linter repos.
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Oct 23, 2026 — with Claude
@shenxianpeng shenxianpeng self-assigned this Oct 23, 2026
@coderabbitai

coderabbitai Bot commented Oct 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 1 minute.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d63f71df-2ded-4da3-9553-6a0a26efb0ad
📥 Commits

Reviewing files that changed from the base of the PR and between d61ef6c and c7694c9.

📒 Files selected for processing: 4
  • .github/workflows/release-drafter.yml
  • README.md
  • examples/cmake/README.md
  • examples/meson/README.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Oct 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (d61ef6c) to head (c7694c9).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #307   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          541       541           
=========================================
  Hits           541       541           

☔ View full report in Codecov by Harness.
📢 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 b9c5bee into main Oct 23, 2026
32 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-jz4xdm branch October 23, 2026 08:29
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.

1 participant