Skip to content

docs: update the examples to v1.6.1 - #290

Merged
shenxianpeng merged 1 commit into
mainfrom
release/v1.6.1
Sep 30, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
release/v1.6.1

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

Prepares the README for the v1.6.1 release.

Checked with pre-commit on main (409c5ca) and args: [--style=Google, --version=21, --dry-run]: the hook fails with exit code 1, prints the -Wclang-format-violations lines shown in the README, and leaves the file unchanged.

Merge this before publishing v1.6.1, so the release and its PyPI page carry this README. Until the tag exists, rev: v1.6.1 does not resolve.

Summary by CodeRabbit

  • Documentation
    • Updated configuration examples to use v1.6.1.
    • Clarified that the clang-format hook fails and reports formatting violations when files need formatting.
    • Removed the comparison-table claim that --dry-run always passes in v1.6.0.

v1.6.1 releases the --dry-run fix from #257: the hook now fails and
prints the lines to fix. Drop the note and the table entry that said
--dry-run always passes in v1.6.0.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 30, 2026
@sonarqubecloud

Copy link
Copy Markdown

@shenxianpeng
shenxianpeng merged commit 85389ec into main Sep 30, 2026
26 of 27 checks passed
@shenxianpeng
shenxianpeng deleted the release/v1.6.1 branch September 30, 2026 23:00
@codecov

codecov Bot commented Sep 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.53%. Comparing base (409c5ca) to head (328325b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #290   +/-   ##
=======================================
  Coverage   97.53%   97.53%           
=======================================
  Files           3        3           
  Lines         243      243           
=======================================
  Hits          237      237           
  Misses          6        6           

☔ 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 added a commit to cpp-linter/cpp-linter.github.io that referenced this pull request Sep 30, 2026
Moves every `.pre-commit-config.yaml` example from `rev: v1.6.0` to
`rev: v1.6.1`:

- Get started
- Why cpp-linter
- The four blog posts that show the hooks

Nothing else on the site depends on the v1.6.0 behavior.

Merge this after cpp-linter-hooks v1.6.1 is published
(cpp-linter/cpp-linter-hooks#290 goes first). Until the tag exists,
`rev: v1.6.1` does not resolve.
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