Skip to content

docs: document --rev and the skip notice, and date v2.14.0 - #15

Merged
shenxianpeng merged 2 commits into
mainfrom
docs/rev-and-skip-notice
Aug 12, 2026
Merged

docs: document --rev and the skip notice, and date v2.14.0#15
shenxianpeng merged 2 commits into
mainfrom
docs/rev-and-skip-notice

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Aug 12, 2026

Copy link
Copy Markdown
Member

Documentation for the engine changes merged in commit-check/commit-check#544, ahead of the v2.15.0 release, plus the release date for v2.14.0.

Command-line recipes (example.md)

  • A "From a revision" tab under message checking: --rev takes anything git rev-parse understands, errors up front on a revision that does not resolve, and refuses to be combined with a message file or stdin.
  • The author-check section now says whose identity is judged: without --rev it is the local git config (right for a hook, wrong for CI); with --rev it is that commit's recorded author, and the config is never consulted.
  • The range-checking recipe drops the stdin pipe for --rev, which also lets it include the author checks meaningfully, and shows git rev-list HEAD^1..HEAD^2 for covering exactly a PR's commits.
  • A new "When a check is skipped" section: which rules decline merge subjects and why only git's literal Merge /fixup! prefixes qualify, the one-line stderr notice, the JSON "status": "skip", and a warning box about the synthetic-merge-commit trap on pull_request checkouts.

Both console examples are pasted from real runs of the current engine, not written by hand.

Changelog

  • New v2.15.0 (unreleased) entry: --rev, the stdin-hang fix, skip visibility, and the tightened merge/fixup bypass.
  • v2.14.0 stamped with its release date (published 2026-08-12).
  • Highlights table row for 2.15.0.

mkdocs build -s passes (social cards disabled locally — the build environment cannot reach fonts.google.com; nothing in this diff touches that path).

The recipes page gains a revision tab for message checks, the author-check
section explains what --rev changes about whose identity is judged, the
range recipe drops the stdin pipe for --rev, and a new section documents
the skip status: which rules decline merge subjects, the stderr notice,
and the JSON status. Both examples are pasted from real runs.

The changelog gains the v2.15.0 entry for the engine changes shipping in
it and stamps v2.14.0 with its release date.
@netlify

netlify Bot commented Aug 12, 2026

Copy link
Copy Markdown

Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 0c9310e
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6a7c38ba200c2400086c2e11
😎 Deploy Preview https://deploy-preview-15--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@shenxianpeng, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 57 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 05a9c0de-a7aa-46a9-9216-4e334ef7ef03

📥 Commits

Reviewing files that changed from the base of the PR and between 9a3f758 and 0c9310e.

📒 Files selected for processing (5)
  • docs/changelog.md
  • docs/configuration.md
  • docs/example.md
  • docs/guides/integrations.md
  • docs/index.md
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/rev-and-skip-notice

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.

The docs-sync test pins every install snippet to the released version,
which became 2.14.0 today.
@shenxianpeng
shenxianpeng merged commit 90bf806 into main Aug 12, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the docs/rev-and-skip-notice branch August 12, 2026 09:14
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.

1 participant