Skip to content

docs: link the App's install page, not its Marketplace listing #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 1 commit into from
Sep 25, 2026
Merged

docs: link the App's install page, not its Marketplace listing #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ All three run the same `commit-check` engine against the same
`commit-check.toml` / `cchk.toml`; they differ in where they run and what they
can see.

| | GitHub Action (this repo) | [pre-commit hook](https://github.com/commit-check/commit-check#use-with-pre-commit) | [Commit Check GitHub App](https://github.com/marketplace/commit-check) |
| | GitHub Action (this repo) | [pre-commit hook](https://github.com/commit-check/commit-check#use-with-pre-commit) | [Commit Check GitHub App](https://github.com/apps/commit-check) |
|---|---|---|---|
| **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 |
| **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 |
Expand Down Expand Up @@ -523,7 +523,7 @@ By default, commit-check-action handles this gracefully:
> **For most projects, this is sufficient** — a fork contributor already gets the red
> check, the per-finding annotations on their diff and the full report in the job
> summary. If you want feedback on the pull request itself, the
> [Commit Check GitHub App](https://github.com/marketplace/commit-check) posts a check
> [Commit Check GitHub App](https://github.com/apps/commit-check) posts a check
> run per commit with no workflow file (free on public repositories), or you can run
> this action on `pull_request_target`. Both are covered in
> **[Fork pull requests](docs/fork-pr-comments.md)**.
Expand Down
2 changes: 1 addition & 1 deletion docs/fork-pr-comments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The run is **not** failed by this: `pr-comments: true` on a fork PR is a no-op,

### Install the Commit Check GitHub App (recommended)

The [Commit Check GitHub App](https://github.com/marketplace/commit-check) is not bound by
The [Commit Check GitHub App](https://github.com/apps/commit-check) is not bound by
the `pull_request` token at all: it receives the `pull_request` webhook on the **base**
repository and acts with its own installation token. Fork pull requests are ordinary
pull requests to it.
Expand Down
Loading