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 0db5e82
Browse filesBrowse the repository at this point in the historyBrowse files
refactor: drop the report output and the two-workflow fork pattern for the App
A fork pull request only loses the comment: the check status, the
annotations on the Files changed tab, the job summary and the result
output all work, and pr-comments on a fork is a no-op rather than an
error. The two-workflow pattern spent two files, an artifact round trip,
actions: read and a smuggled PR number to move information the
contributor could already see into a comment, and the report output
existed only to feed it.
The Commit Check GitHub App receives the pull_request webhook on the base
repository and acts with its own token, so fork PRs are ordinary PRs to
it: one check run per commit, no workflow file, free on public
repositories, which is where fork PRs happen. docs/fork-pr-comments.md
now says what a fork contributor actually sees, points at the App, and
keeps pull_request_target with its security warning for anyone who
cannot install one. The file name stays so links from released versions
still resolve.
The random heredoc delimiter stays: it protects the result output, whose
JSON quotes commit subjects and error text as they are.
Co-Authored-By: Claude Opus 5 <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's message, plus the PR title, branch and author checks you enable; 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 | Every commit of a push or pull request: message, branch, author (the PR title only in squash mode); reported as one **Commit Check** check run per commit |
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 a check run without the [two-workflow pattern](docs/fork-pr-comments.md) (no PR comment, though) |
109
+
| **What it checks** | Every PR commit's message, plus the PR title, branch and author checks you enable; renders a job summary, annotations, a PR comment and the `result` output | Message (`commit-msg` stage), branch, author; tag, force-push and files (`pre-push`) — one commit at a time, before it exists | Every commit of a push or pull request: message, branch, author (the PR title only in squash mode); reported as one **Commit Check** check run per commit |
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, or feedback on [fork pull requests](docs/fork-pr-comments.md) without the Action's read-only-token limits |
111
111
112
112
Most teams pair the pre-commit hook (fast, local) with the Action (enforced):
113
113
the hook catches a bad message before it is pushed, and the Action is why CI
@@ -180,9 +180,10 @@ fails when a contributor did not install the hook.
180
180
> [!NOTE]
181
181
> `pr-comments` is disabled by default.
182
182
>
183
-
> PR comments are skipped for pull requests from forked repositories. See
184
-
> [docs/fork-pr-comments.md](docs/fork-pr-comments.md) for details on how to enable
185
-
> this feature for fork contributions.
183
+
> PR comments are skipped for pull requests from forked repositories, whose
184
+
> `GITHUB_TOKEN` is read-only. Everything else still works there: the check
185
+
> status, the annotations and the job summary. See
186
+
> [Fork pull requests](docs/fork-pr-comments.md).
186
187
>
187
188
> **Dependabot pull requests** are not forks, but GitHub gives their
188
189
> `pull_request` runs a read-only `GITHUB_TOKEN` by default. The `permissions`
Copy file name to clipboardExpand all lines: action.yml
-3Lines changed: 0 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -44,9 +44,6 @@ outputs:
44
44
# mapping (and the step id it refers to) the output is always the empty
45
45
# string, and fromJSON('') fails the calling workflow.
46
46
value: ${{ steps.commit-check.outputs.result }}
47
-
report:
48
-
description: The rendered Markdown report, byte for byte what the job summary and PR comment show. Save it as an artifact from a pull_request run and post it verbatim from a workflow_run job to comment on fork pull requests (see docs/fork-pr-comments.md).
0 commit comments