Skip to content

docs: explain how v2 and v3 of the action relate - #524

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-eikc8z
Nov 10, 2026
Merged

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

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 10, 2026 •

Copy link
Copy Markdown
Member

The README (also the Marketplace page and the docs front page) does not mention v3 or cpp-linter v2. Users who hear about the Rust rewrite cannot tell from here whether their @v2 workflow is affected.

This adds one note under the links line:

  • @v2 runs cpp-linter v1 (Python) and gets bug fixes only.
  • v3 will run cpp-linter v2, with a link to what changes there.
  • @v2 workflows keep working, and nothing changes until a workflow moves to @v3.
  • Link to Moving toward v3 #283 for progress.

Docs only. pre-commit passes on the file.

Summary by CodeRabbit

  • Documentation
    • Clarified the differences between action versions, the status of v3, and what to expect from existing v2 workflows.
    • Added links to migration guidance and v3 tracking information.

Add a note to the README: v2 runs cpp-linter v1 and gets bug fixes
only, v3 will run cpp-linter v2, and `@v2` workflows keep working.
@shenxianpeng
shenxianpeng requested a review from a team as a code owner November 10, 2026 07:42
@shenxianpeng
shenxianpeng requested a review from 2bndy5 November 10, 2026 07:42
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 10, 2026
@shenxianpeng shenxianpeng self-assigned this Nov 10, 2026
@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README distinguishes the implementations and maintenance status of action versions @v2 and planned @v3. It states that existing @v2 workflows remain unchanged unless upgraded.

Changes

Version documentation

Layer / File(s) Summary
Document action version status
README.md
The README describes @v2 as using cpp-linter v1 and receiving bug fixes only. It says @v3 is planned to use cpp-linter v2, currently at release-candidate stage, and links to migration information and the v3 tracking issue.

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

Possibly related issues

  • cpp-linter/cpp-linter-action issue 283: The README describes the same v2-to-v3 transition and links to this issue as the v3 tracker.
  • cpp-linter/cpp-linter-action issue 523: The README mentions the planned cpp-linter v2 runtime, but does not address the issue’s requirement to run the binary without Nu or third-party nested actions.
Merge Risk: Minimal · up to eb006

The README clarifies version status without changing existing workflows. No merge-blocking risk is identified.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the README change that explains how action versions v2 and v3 relate.
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.
  • 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

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: 409eb7a6-3daf-4a86-87e6-91c29c984414
Commits

Reviewing files that changed from the base of the PR and between b503e19 and eb006fa.

Files selected for processing: 1

  • README.md

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

@shenxianpeng
shenxianpeng merged commit 79dfaae into main Nov 10, 2026
12 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-eikc8z branch November 10, 2026 18:03
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.

2 participants