Skip to content

Commit 0549d2d

Browse files
authored
docs(app): say what "install once" depends on, and what the Action costs (#24)
Two of CodeRabbit's findings on #23 landed after it merged, and both are right. - **"Every repository, including ones created later"** holds only when the App is installed with **All repositories** selected. The page now says so, and says what *Only select repositories* means: only those are checked, and new ones have to be added by hand. - **The Action's cost** was "CI minutes", flat. Public repositories and self-hosted runners are not metered; what the Action always costs is a runner per run, and metered minutes only on private repositories. The comparison table says that instead. The third finding on #23 — the Marketplace URL returning 404 — is timing, not the link: the listing is not public until GitHub approves it. Nothing to change there. `pytest tests/ -q` → 9 passed. `SOCIAL_CARDS=false mkdocs build --strict` clean.
1 parent 08f4958 commit 0549d2d

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

‎docs/guides/integrations.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,11 @@ only the commenting is affected.
197197
## As a GitHub App
198198

199199
The hosted [Commit Check App](https://github.com/marketplace/commit-check)
200-
runs the same rules with no workflow file. Install it once on an organization
201-
and every repository, including ones created later, gets a **Commit Check**
202-
result on each commit of every push and pull request.
200+
runs the same rules with no workflow file. Install it on an organization with
201+
**All repositories** selected and every repository, including ones created
202+
later, gets a **Commit Check** result on each commit of every push and pull
203+
request. With **Only select repositories**, only those are checked and new
204+
ones have to be added by hand.
203205

204206
[Install from the GitHub Marketplace](https://github.com/marketplace/commit-check){ .md-button .md-button--primary }
205207

@@ -220,7 +222,7 @@ a 14-day trial.
220222
|---|---|---|
221223
| Setup | Install once for the organization | A workflow file in each repository |
222224
| Runs on | GitHub.com | GitHub.com and GitHub Enterprise Server, any runner |
223-
| Cost | No CI minutes | CI minutes |
225+
| Cost | No CI minutes | A runner per run; metered minutes on private repositories |
224226
| Output | A check run per commit | Job summary, PR comment, `result` output |
225227
| Fits | Organization-wide coverage with no per-repository work | Custom workflows, self-hosted runners, GHES |
226228

0 commit comments

Comments
 (0)