Skip to content

Commit b3e68dd

Browse files
committed
docs: say the Action blocks a merge only once it is required
The Action guide opened with "A CI check cannot [be skipped]". A check that is not required can be: the pull request merges with it red. The page never said how to make it required, though the landing page and the App guide do. The opening now says what a local hook and the Action each do, and a short section says where to require the check and what it is called. GitHub names an Action's check after its job, so with the workflow on the page it is commit-check.
1 parent 8484021 commit b3e68dd

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

‎docs/guides/github-actions.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# GitHub Action
22

3-
Local hooks can be skipped. A CI check cannot, so the Action is where the
4-
policy is enforced.
3+
A local hook can be skipped with `git commit --no-verify`. The Action runs in
4+
CI whatever happened locally, and once it is a
5+
[required status check](#making-it-a-required-check) a pull request that
6+
fails it cannot merge.
57

68
```yaml title=".github/workflows/commit-check.yml"
79
name: Commit Check
@@ -35,6 +37,13 @@ jobs:
3537
The Action reads the same `cchk.toml` as the CLI, so a repository that already
3638
has one needs no Action-specific configuration.
3739

40+
## Making it a required check { #making-it-a-required-check }
41+
42+
Until it is required, a failing Commit Check does not stop anyone from
43+
merging. Require it in the branch's ruleset or branch protection, where the
44+
repository's plan allows one. GitHub names an Action's check after its job, so
45+
with the workflow above the check to require is `commit-check`.
46+
3847
## Commenting on the pull request
3948

4049
Instead of making contributors open the job log, have the Action post what

0 commit comments

Comments
 (0)