You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 781a040
Browse filesBrowse the repository at this point in the historyBrowse files
docs(readme): explain fetch-depth, runner requirements, Dependabot, and the alternatives
The usage snippet's fetch-depth comment did not say what a shallow clone
costs: the action falls back to GitHub's merge commit, whose subject passes
the default rules, so every PR looks green and author checks are skipped.
Spell that out in the comment and a WARNING callout, with the exact
annotation the run carries.
Add a "Runner requirements" section (Python 3.10+, the gh CLI for the
attestation check, PyPI and api.github.com access, git; which wheels are and
are not attested; no input skips verification) — action.yml now points
self-hosted operators here. Add the "Action, pre-commit hook, or GitHub App"
comparison so evaluators can pick, and note under pr-comments that
Dependabot pull requests are skipped like forks because GitHub runs their
pull_request workflows with a read-only token.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018xYa7m3qup5wyN5MaXFgf6
| **Where it runs** | In your workflow, on the runner, after the push | On the contributor's machine, at `git commit` / `git push` | Hosted by commit-check; installed on the repository, no workflow file |
109
+
| **What it checks** | Every PR commit, the PR title, branch and author; renders a job summary, annotations, a PR comment and the `result` / `report` outputs | Message (`commit-msg` stage), branch, author; tag, force-push and files (`pre-push`) — one commit at a time, before it exists | The pull request's commits, title and branch, reported on the pull request |
110
+
| **When to pick it** | You want enforcement in CI that a contributor cannot skip, per-rule outputs for later steps, or you run on GitHub Enterprise Server / need `CCHK_*` overrides | You want the fastest feedback and to stop bad commits before they are pushed; pair it with the Action, since hooks are opt-in | You want zero YAML and no Actions minutes; fork PRs get comments without the [two-workflow pattern](docs/fork-pr-comments.md) |
111
+
112
+
Most teams pair the pre-commit hook (fast, local) with the Action (enforced):
113
+
the hook catches a bad message before it is pushed, and the Action is why CI
114
+
fails when a contributor did not install the hook.
115
+
69
116
## Used By
70
117
71
118
<p align="center">
@@ -137,6 +184,15 @@ jobs:
137
184
> [docs/fork-pr-comments.md](docs/fork-pr-comments.md) for details on how to enable
138
185
> this feature for fork contributions.
139
186
>
187
+
> **Dependabot pull requests** are skipped the same way. GitHub runs
188
+
> Dependabot-triggered `pull_request` workflows with a read-only token even
189
+
> when the workflow requests `pull-requests: write`, so the permission is not
190
+
> the problem: the action logs a `::warning::`, leaves the report in the job
191
+
> summary, and the step still exits by the checks' result. To comment on them
192
+
> too, use the [two-workflow pattern](docs/fork-pr-comments.md), or run on
193
+
> `pull_request_target` for Dependabot only. Adding `dependabot[bot]` to
194
+
> `ignore_authors` skips the checks for those PRs altogether.
195
+
>
140
196
> Note: write-access to pull-requests requires the `pull-requests: write` permission.
0 commit comments