Skip to content

docs: explain the v2.24 ignore and database path changes - #515

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-nfsfml
Oct 26, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-nfsfml

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

v2.24.0 ships cpp-linter 1.15.1, which changes two path rules. Users who upgrade through @v2 can now find both in the input docs:

  • ignore: a path only matches relative to repo-root, so build no longer skips src/build/ (1.14 did, by mistake). The docs now say so and show ignore: '**/build|.github' for skipping a folder at any depth.
  • database: a relative path is relative to GITHUB_WORKSPACE, not to repo-root.

I checked these rules with cpp-linter 1.15.1 on a test repo containing build/, src/build/ and src/x/build/:

repo-root ignore files left
. build src/a.cpp, src/build/b.cpp, src/x/build/d.cpp
. **/build|.github src/a.cpp
src build a.cpp, x/build/d.cpp

*/build/ (with a trailing slash) matches nothing, and */build only matches one level down, so the docs recommend **/.

Summary by CodeRabbit

  • Documentation
    • Clarified that ignore paths match relative to the repository root, with examples for matching folders at any depth.
    • Specified that relative database paths are resolved from the workspace.

@shenxianpeng
shenxianpeng requested a review from a team as a code owner October 26, 2026 11:18
@shenxianpeng
shenxianpeng requested review from 2bndy5 and removed request for a team October 26, 2026 11:18
@shenxianpeng shenxianpeng self-assigned this Oct 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Cpp-Linter Report ⚠️

Some files did not pass the configured checks!

clang-format (v16.0.6) reports: 2 file(s) not formatted
  • docs/examples/demo/demo.cpp
  • docs/examples/demo/demo.hpp
clang-tidy (v16.0.6) reports: 7 concern(s)

✨ Powered by cpp-linter -- ⭐ Star • ❤️ Sponsor • 💬 Feedback

@coderabbitai

coderabbitai Bot commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
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: 341f8fce-4d59-4abc-8df7-4b57f5924d56
Commits

Reviewing files that changed from the base of the PR and between 774040a and ed41722.

Files selected for processing: 1
  • action.yml

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

Walkthrough

The ignore input documentation describes repo-root-relative matching and gives examples. The database input documentation states that relative paths resolve from GITHUB_WORKSPACE.

Changes

Input path documentation

Layer / File(s) Summary
Document input path semantics
action.yml
The ignore description explains repo-root-relative matching with examples. The database description states that relative paths use GITHUB_WORKSPACE as their base.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Merge Risk: Minimal · up to ed417

No actionable merge-blocking risk remains; the documentation changes are ready to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main documentation changes for the v2.24 ignore and database path behavior.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

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

@shenxianpeng
shenxianpeng enabled auto-merge (squash) October 26, 2026 15:19

@2bndy5 2bndy5 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It seems odd to document a bug fix like this (for ignore). But I'm not against getting knowledge out there any way possible.

@shenxianpeng
shenxianpeng merged commit 3992b4c into main Oct 26, 2026
45 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-nfsfml branch October 26, 2026 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants