Skip to content

Conversation

2bndy5
Copy link
Contributor

@2bndy5 2bndy5 commented Aug 13, 2025

I will remove the useless docs/requirements.txt after cpp-linter/.github#38 is merged.

Summary by CodeRabbit

  • Documentation

    • Streamlined documentation build: removed legacy make scripts and shifted the theme dependency to a dedicated docs dependency group, reducing setup friction.
    • Adjusted documentation dependencies to install via the project configuration instead of a separate requirements file.
  • Chores

    • Updated CI to recognize and run clang tools for version 20 on Windows, ensuring consistent static analysis coverage across platforms.

Copy link

codecov bot commented Aug 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.42%. Comparing base (2b9e3ec) to head (eaf16ff).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #122   +/-   ##
=======================================
  Coverage   95.42%   95.42%           
=======================================
  Files           7        7           
  Lines         284      284           
=======================================
  Hits          271      271           
  Misses         13       13           

☔ 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 added the enhancement New feature or request label Aug 13, 2025
Copy link

coderabbitai bot commented Aug 13, 2025

Walkthrough

Expanded Windows clang-tools case in GitHub Actions to include version 20. Removed Sphinx Makefile and Windows batch script from docs. Moved sphinx-immaterial dependency from docs/requirements.txt into a new [dependency-groups].docs section in pyproject.toml.

Changes

Cohort / File(s) Summary
CI workflow update
.github/workflows/python-test.yml
Extend Windows clang-tools case pattern to include version 20, routing matrix.version=20 to the Windows-specific tool invocations.
Docs build script removal
docs/Makefile, docs/make.bat
Delete Sphinx Makefile and Windows batch launcher used for building docs.
Docs dependency management
docs/requirements.txt, pyproject.toml
Remove sphinx-immaterial from docs/requirements.txt; add [dependency-groups].docs with sphinx-immaterial>=0.13.5 in pyproject.toml.

Sequence Diagram(s)

sequenceDiagram
    participant GA as GitHub Actions
    participant Job as Test Matrix Job
    participant Step as Check clang-tools (Windows)

    GA->>Job: Run with matrix.version
    Job->>Step: Determine tool paths
    alt Windows and version in {15,16,18,20}
        Step->>Step: Use Windows-specific clang-* executables
    else Otherwise
        Step->>Step: Use alternative/else branch
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch switch-to-uv

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🔭 Outside diff range comments (2)
.github/workflows/python-test.yml (2)

107-117: Inconsistent handling of Windows non-suffixed binaries; include 18 and 20 here as well.

The “Show path of binaries” step only treats 15 and 16 as non-suffixed on Windows, but the later check step handles 15, 16, 18, 20. Align them to avoid false negatives.

Apply this diff:

-          if [ "${{ matrix.version }}" = "15" -o "${{ matrix.version }}" = "16" ] && [ "${{ matrix.os }}" = "windows-latest" ]; then
+          if [ "${{ matrix.os }}" = "windows-latest" ] && echo "15 16 18 20" | grep -qw "${{ matrix.version }}"; then
               which clang-format
               which clang-tidy
               which clang-query
               which clang-apply-replacements
           elif [ "${{ matrix.os }}" = "ubuntu-latest" ]; then
               which "clang-format-${{ matrix.version }}"
               which "clang-tidy-${{ matrix.version }}"
               which "clang-query-${{ matrix.version }}"
               which "clang-apply-replacements-${{ matrix.version }}"
           fi

139-151: macOS step never runs: matrix uses “macos-13” but condition checks “macos-latest”.

As written, the Unix check won’t execute on macOS builds. Fix the condition to include macOS 13 (or use startsWith).

Apply this diff:

-      - name: Check clang-tools on Unix
-        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
+      - name: Check clang-tools on Unix
+        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-13'
         run: |
           if [ "${{ matrix.version }}" = "12.0.1" -a "${{ matrix.os }}" = "ubuntu-latest" ]; then
             clang-format-12.0.1 --version
             clang-tidy-12.0.1 --version
             clang-query-12.0.1 --version
             clang-apply-replacements-12.0.1 --version
           else
             clang-format-${{ matrix.version }} --version
             clang-tidy-${{ matrix.version }} --version
             clang-query-${{ matrix.version }} --version
             clang-apply-replacements-${{ matrix.version }} --version
           fi

Alternatively, make it future-proof:

-        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
+        if: matrix.os == 'ubuntu-latest' || startsWith(matrix.os, 'macos')
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2b9e3ec and eaf16ff.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (5)
  • .github/workflows/python-test.yml (1 hunks)
  • docs/Makefile (0 hunks)
  • docs/make.bat (0 hunks)
  • docs/requirements.txt (0 hunks)
  • pyproject.toml (1 hunks)
💤 Files with no reviewable changes (3)
  • docs/requirements.txt
  • docs/make.bat
  • docs/Makefile
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: install (12.0.1, windows-latest)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (2)
pyproject.toml (1)

95-98: Verify that shared Sphinx workflow installs the docs group with uv

Our search did not uncover any uv commands or docs-group installs in this repo’s workflows, nor any lingering docs/requirements.txt references. Since you’ve removed docs/requirements.txt and moved the Sphinx theme into the [dependency-groups]:

  • Ensure your local docs build (or the downstream reusable workflow in cpp-linter/.github) invokes one of:
    • uv sync -g docs
    • uv pip install -e . -g docs
  • Confirm any .github/workflows/*.yml jobs that build docs include that step before running sphinx-build, so sphinx-immaterial is actually installed.
.github/workflows/python-test.yml (1)

124-129: Windows case extended to include LLVM 20 — LGTM.

Adding 20 to the non-suffixed Windows binaries case matches the observed naming on those LLVM distributions.

@2bndy5
Copy link
Contributor Author

2bndy5 commented Aug 13, 2025

Thanks for the test fix!

@2bndy5 2bndy5 merged commit c77b619 into main Aug 13, 2025
58 checks passed
@2bndy5 2bndy5 deleted the switch-to-uv branch August 13, 2025 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants