Skip to content

Conversation

shenxianpeng
Copy link
Collaborator

@shenxianpeng shenxianpeng commented Sep 19, 2025

Summary by CodeRabbit

  • Chores
    • Removed legacy benchmark workflow and related artifacts.
    • Updated pre-commit tooling: split linting and formatting steps and upgraded Ruff.
  • Documentation
    • Reworded README for clearer description.
    • Revamped benchmarking guide with updated steps, comparison workflow, and results summary.
    • Linked benchmark instructions from testing docs.
  • Tests
    • Added configuration to test the clang-format hook.
    • Removed obsolete benchmark-specific test configuration and outputs.

@shenxianpeng shenxianpeng added the developer Changes that impact developers label Sep 19, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 19, 2025
Copy link
Contributor

@Copilot 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 benchmark script to use hyperfine instead of a custom Python timing implementation for performance measurements, and updates the cpp-linter-hooks version being tested.

  • Replaces custom Python benchmark implementation with hyperfine tool
  • Updates cpp-linter-hooks version from v1.1.2 to v1.1.3
  • Removes version argument from clang-format configuration

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
testing/benchmark_hooks.py Replaces custom timing logic with hyperfine subprocess call
testing/benchmark_hook_1.yaml Updates hook version and removes version argument
testing/benchmark.md Adds hyperfine usage example to documentation

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

Copy link

codecov bot commented Sep 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.39%. Comparing base (a076581) to head (07369ee).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #122   +/-   ##
=======================================
  Coverage   94.39%   94.39%           
=======================================
  Files           3        3           
  Lines         107      107           
=======================================
  Hits          101      101           
  Misses          6        6           

☔ 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.

Copy link

@shenxianpeng shenxianpeng marked this pull request as ready for review September 19, 2025 20:09
@shenxianpeng shenxianpeng removed the documentation Improvements or additions to documentation label Sep 19, 2025
@shenxianpeng shenxianpeng merged commit 3aafa8a into main Sep 19, 2025
15 of 16 checks passed
@shenxianpeng shenxianpeng deleted the update-benchmark branch September 19, 2025 20:09
Copy link

coderabbitai bot commented Sep 19, 2025

Caution

Review failed

The pull request is closed.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Removes benchmark automation (workflow, script, results, and a hook config), restructures benchmark documentation, adjusts testing README to point to the new doc, splits Ruff pre-commit hooks into lint and format with version bump, tweaks main README wording, and adds a new test pre-commit config for cpp-linter-hooks.

Changes

Cohort / File(s) Summary
Benchmark automation removal and docs update
.github/workflows/benchmark.yml, testing/benchmark_hooks.py, testing/benchmark_results.txt, testing/benchmark_hook_1.yaml, testing/README.md, testing/benchmark.md
Deleted workflow and Python benchmark tool, removed stored results and an old benchmark hook config; updated testing README to link to benchmark.md; rewrote benchmark.md to document manual and comparative benchmarking with hyperfine.
Pre-commit: Ruff split and bump
.pre-commit-config.yaml
Bumped Ruff from v0.12.11 to v0.13.1; replaced single ruff hook (with --fix) with two hooks: ruff-check (lint) and ruff-format (format); added inline comments.
README wording tweak
README.md
Rephrased the pre-commit hook description; no functional changes.
New test hook config
testing/test-cpp-linter-hooks.yaml
Added pre-commit repo entry for cpp-linter/cpp-linter-hooks@v1.1.3 with clang-format hook (args: [--style=file]).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • feat: add benchmark #101 — Introduced the benchmark workflow and scripts now being removed/rewritten in this PR, affecting the same files and functionality.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-benchmark

📜 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 a076581 and 07369ee.

📒 Files selected for processing (9)
  • .github/workflows/benchmark.yml (0 hunks)
  • .pre-commit-config.yaml (1 hunks)
  • README.md (1 hunks)
  • testing/README.md (1 hunks)
  • testing/benchmark.md (1 hunks)
  • testing/benchmark_hook_1.yaml (0 hunks)
  • testing/benchmark_hooks.py (0 hunks)
  • testing/benchmark_results.txt (0 hunks)
  • testing/test-cpp-linter-hooks.yaml (1 hunks)

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer Changes that impact developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant