Skip to content

docs: the Action card overstated what CI enforcement does - #37

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/submit-patch-commit-check-42ac3i
Sep 7, 2026
Merged

docs: the Action card overstated what CI enforcement does#37
shenxianpeng merged 1 commit into
mainfrom
claude/submit-patch-commit-check-42ac3i

Conversation

@shenxianpeng

Copy link
Copy Markdown
Member

The "GitHub Action" card on the home page said the Action is "enforcement in CI that a contributor cannot skip".

Two other places on the same page are careful about exactly this:

  • the pricing note — "the only way Commit Check blocks a merge is if you make it a required check yourself"
  • the FAQ — "Make the Action or the App a required status check and a violating change cannot merge"

So the card was the odd one out, and it is the one a reader meets first. An Action that is not a required status check runs, reports, and the pull request merges anyway.

The new wording keeps the contrast the card was drawing with the pre-commit hook card above it — which a contributor genuinely can skip with --no-verify — and states the condition for blocking a merge:

Runs in CI whether or not the hook ran. Make it a required check and a violation cannot merge, with per-rule outputs later steps can gate on.

Found by CodeRabbit on #36, which merged before the fix could be applied there.

pytest tests/ passes (10) and mkdocs build --strict is clean.


🤖 Generated with Claude Code

https://claude.ai/code/session_018xYa7m3qup5wyN5MaXFgf6


Generated by Claude Code

The "GitHub Action" card said the Action is "enforcement in CI that a
contributor cannot skip". Two other places on the same page are careful
about this -- the pricing note says the only way Commit Check blocks a
merge is if you make it a required check, and the FAQ says to make the
Action or the App a required status check -- so the card was the odd one
out, and the one a reader meets first.

An Action that is not a required status check runs and reports and merges
anyway. The new wording keeps the contrast the card was drawing with the
pre-commit hook above it, which a contributor genuinely can skip with
--no-verify, and states the condition for blocking a merge:

  Runs in CI whether or not the hook ran. Make it a required check and a
  violation cannot merge, with per-rule outputs later steps can gate on.

Found by CodeRabbit on #36, which merged before it could be applied there.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018xYa7m3qup5wyN5MaXFgf6
@netlify

netlify Bot commented Sep 7, 2026

Copy link
Copy Markdown

Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 869ec16
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6a9eb19ee1077c00080f4251
😎 Deploy Preview https://deploy-preview-37--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 Sep 7, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 41 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

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

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: e02345eb-13b6-4132-b648-904f550f1105

📥 Commits

Reviewing files that changed from the base of the PR and between c3cda24 and 869ec16.

📒 Files selected for processing (1)
  • docs/index.md

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 merged commit 5f1a6a0 into main Sep 7, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the claude/submit-patch-commit-check-42ac3i branch September 7, 2026 13:24
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