Skip to content

docs: AI-only and real-project recipes, CC017, v2.20.0 - #76

Merged
shenxianpeng merged 5 commits into
mainfrom
chore/ai-check-only-recipe
Nov 8, 2026
Merged

shenxianpeng merged 5 commits into
mainfrom
chore/ai-check-only-recipe

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 8, 2026 •

Copy link
Copy Markdown
Member

What

Site docs for commit-check v2.20.0 and Action v2.19.0, plus AI policy recipes.

  • Policies guide, "Checking AI attribution and nothing else": for projects that only want ai_attribution, with the setup as cchk.toml and as Action env vars (subject_max_length = 0 turns the length rule off since 2.20.0).
  • Policies guide, "Recipes from real projects": Kubernetes, the Linux kernel, Nextcloud, pip/attrs and Fedora/FluxCD each mapped to a few lines of cchk.toml, plus a recipe for projects that want every commit to declare AI use (Assisted-by: none when there was none). Each recipe was run against sample commits on 2.20.0.
  • Rules: new ai-author (CC017) section; CC004/CC005 say 0 turns the rule off; CC013 names Continue, Mistral Vibe and Qwen Code.
  • Changelog: v2.20.0 entry and highlights row.
  • Python 3.11: getting started, home page facts and the Python API guide; the GitHub Action guide gets a note that ubuntu-22.04 needs actions/setup-python.
  • Pins: install snippets bumped from v2.19.5 to v2.20.0.

Before / after

Before After
Running only the AI check not documented; the default 80/5 length rules still apply a recipe with conventional_commits = false and both lengths 0
Copying a known project's AI policy not documented; projects write their own grep step a table of five policies and their config, with two full recipes
CC017 no section (docs-sync red) What it does / Why / Example / Options
Supported Python 3.10 – 3.15 3.11 – 3.15, with the ubuntu-22.04 note
pre-commit rev v2.19.5 v2.20.0

New "Recipes from real projects" section:

Recipes from real projects

Not in this PR

Warp, Crush and the credit trailers go in the tool list after commit-check#672 ships.

Checks

python -m pytest tests/ -q with commit-check 2.20.0: 18 passed. mkdocs build --strict: clean.

Summary by CodeRabbit

  • Documentation
    • Updated the guides to describe AI-authorship checks, recognized tool signatures, and author exclusions and warnings.
    • Clarified that setting either subject-length limit to 0 disables that check.
    • Updated the documented minimum Python version to 3.11 and added GitHub Actions setup guidance.
    • Added configuration recipes and refreshed installation examples to use v2.20.0.

- Policies guide: a section on running the AI check alone, with
  conventional_commits = false and subject length 0, as cchk.toml and as
  Action env vars.
- CC004 / CC005 and the configuration reference: 0 turns the length
  rule off.
- CC013 and the policies guide list Continue, Mistral Vibe and Qwen Code.

Describes behaviour in the next commit-check release; merge after it ships.
@netlify

netlify Bot commented Nov 8, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit efcd368
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6af0d804efbaa7c73fe55948
😎 Deploy Preview https://deploy-preview-76--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 Nov 8, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

Walkthrough

The documentation describes CC017 AI-author checks, recognized tool signatures, zero-valued subject-length settings, and Python 3.11 support. It also updates the 2.20.0 changelog entry and pre-commit examples.

Changes: Release Documentation

Layer / File(s) Summary
AI attribution rules and policy examples
docs/rules.md, docs/guides/policies.md
The guides list additional AI signatures and document CC017 behavior, attribution configuration, and project-specific policy examples.
Runtime and configuration guidance
docs/configuration.md, docs/rules.md, docs/getting-started.md, docs/index.md, docs/guides/github-actions.md, docs/guides/python-api.md
The documentation states that setting either subject-length limit to 0 disables its check. It updates the minimum Python version to 3.11 and describes the GitHub Action runner requirement. The Python API example imports tomllib directly.
Release notes and versioned examples
docs/changelog.md, docs/compare/tools.md, docs/configuration.md, docs/example.md, docs/guides/pre-commit.md
The changelog adds the 2.20.0 release entry. Pre-commit examples use version v2.20.0 instead of v2.19.5.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: Moderate · up to efcd3

Clarify interpreter selection before merging so existing Python 3.10 setups do not encounter blocked commits. Correct the attribution recipes and support references so users understand what their configuration actually enforces.

- [ ] 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

@shenxianpeng shenxianpeng self-assigned this Nov 8, 2026
Kubernetes, the Linux kernel, Nextcloud, pip/attrs and Fedora/FluxCD each map to a few lines of cchk.toml, plus a recipe for projects that want every commit to declare AI use (Assisted-by: none when there was none).
Adds the ai-author (CC017) rule section, the v2.20.0 changelog entry, the Python 3.11 note for the Action (ubuntu-22.04 needs setup-python), and bumps the install pins to v2.20.0.
@shenxianpeng shenxianpeng changed the title docs: add an "AI attribution only" recipe and the new AI tools docs: AI-only and real-project recipes, CC017, v2.20.0 Nov 8, 2026
@shenxianpeng
shenxianpeng marked this pull request as ready for review November 8, 2026 20:14
@shenxianpeng
shenxianpeng merged commit d51bdc0 into main Nov 8, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the chore/ai-check-only-recipe branch November 8, 2026 20:21
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