Skip to content

Commit 281dad6

Browse files
committed
gh check naming
1 parent a5502b3 commit 281dad6

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

s5_continuous_integration/github_actions.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,8 +265,30 @@ Let's take a look at how a GitHub workflow file is organized:
265265
can bypass the rules by adding `Repository admin` to the bypass list. Implement the following rules:
266266

267267
* At least one person needs to approve any PR
268-
* All your workflows need to pass
269268
* All conversations need to be resolved
269+
* All your workflows need to pass
270+
271+
??? note "Finding the correct names of the checks"
272+
273+
When selecting which checks should be required you may have a hard time finding the correct names of the
274+
checks. The problem is most likely that you should not be looking for the name of your workflows but instead
275+
the name of the jobs e.g. if your workflow file looks like this:
276+
277+
```yaml
278+
name: Code linting
279+
280+
on:
281+
push:
282+
branches: [main]
283+
pull_request:
284+
branches: [main]
285+
286+
jobs:
287+
format:
288+
name: Check code formatting
289+
```
290+
291+
then you should search for `Check code formatting` and not `Code linting`.
270292

271293
3. If you have created the rules correctly you should see something like the image below when you try to merge a
272294
pull request. In this case, all three checks are required to pass before the code can be merged. Additionally,

0 commit comments

Comments
 (0)