Skip to content

Commit d3a4670

Browse files
committed
docs: rename ai_declaration_options to ai_declaration_checkboxes
1 parent cd21e10 commit d3a4670

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ runners need a few tools — see [Good to know](#good-to-know).
8181
| `author-email` | `false` | Check each commit's author email |
8282
| `pr-title` | `false` | Check the pull request title against Conventional Commits — the one that matters for squash merges. Pull request events only |
8383
| `message-ai-attribution` | `false` | Check every commit against the AI rules of `cchk.toml` (`ai_attribution`) only, author included, without the format rules. Takes the place of `message` |
84-
| `pr-body-ai-attribution` | `false` | Check the pull request description against the AI rules of `cchk.toml` (`ai_attribution`, and the AI declaration boxes of `[pull_request] ai_declaration_options`) only. Pull request events only |
84+
| `pr-body-ai-attribution` | `false` | Check the pull request description against the AI rules of `cchk.toml` (`ai_attribution`, and the AI declaration boxes of `[pull_request] ai_declaration_checkboxes`) only. Pull request events only |
8585
| `ai-label` | `false` | Label the pull request when an AI tool wrote any of it (a commit, the description, or an agent's app that opened it): `true` for `ai-assisted`, or the label's name. Labels are only added, never removed. Needs `pull-requests: write`; skipped on fork pull requests under `pull_request` |
8686
| `pr-comments` | `false` | Post the report as a pull request comment, edited in place on later runs. Needs `pull-requests: write`; skipped on fork pull requests |
8787
| `job-summary` | `true` | Write the report to the job summary |
@@ -218,7 +218,7 @@ one of them (CC501). An empty description fails too:
218218

219219
```toml
220220
[pull_request]
221-
ai_declaration_options = ["No AI tools were used", "AI tools were used"]
221+
ai_declaration_checkboxes = ["No AI tools were used", "AI tools were used"]
222222
```
223223

224224
> ```diff

‎main.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -996,7 +996,7 @@ def run_commit_check() -> tuple[int, list[ScopeResult]]:
996996
pr_body = get_pr_body()
997997
if PR_BODY_AI_ATTRIBUTION_ENABLED:
998998
# An empty description is checked too: it has no AI declaration,
999-
# which CC501 fails when [pull_request] ai_declaration_options
999+
# which CC501 fails when [pull_request] ai_declaration_checkboxes
10001000
# names the boxes. The attribution rules pass empty text.
10011001
scope = check_scope(
10021002
"PR description", ["--ai-attribution-only"], input_text=pr_body or ""

0 commit comments

Comments
 (0)