Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 1 commit into from
Nov 10, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ reviews (with [`tidy-review`][tidy-review] or [`format-review`][format-review]).
[Get started](https://cpp-linter.github.io/getting-started/#on-every-pull-request) ·
[Discussions](https://github.com/orgs/cpp-linter/discussions)

> [!NOTE]
> `cpp-linter/cpp-linter-action@v2` runs cpp-linter v1 (Python) and gets bug fixes only.
> v3 will run cpp-linter v2, a rewrite in Rust that is in release candidate stage
> ([what changes in cpp-linter v2](https://cpp-linter.github.io/cpp-linter-rs/migration/)).
> Workflows that use `@v2` keep working as they are, and nothing changes until you move to `@v3`.
> Follow [the v3 tracking issue](https://github.com/cpp-linter/cpp-linter-action/issues/283) for
> progress.

## Quick start

Save this as `.github/workflows/cpp-linter.yml`:
Expand Down
Loading