Skip to content

docs: document glob matching for author scan filters #51

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

Open
alan-hacktron wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −9
Open

docs: document glob matching for author scan filters #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0edc44c
docs: document glob matching for author scan filters
alan-hacktron Jul 28, 2026
c358a08
style: fix prettier formatting in config.mdx
alan-hacktron Jul 28, 2026
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
18 changes: 10 additions & 8 deletions code-review/config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Rules are evaluated in this order, first match applies:
| `exclude.labels` | the PR/MR carries one of these labels | case-insensitive exact match |
| `exclude.keywords` | the PR/MR **title** contains one of these strings | case-insensitive substring |
| `exclude.paths` | **every** changed file matches one of these patterns | case-insensitive glob |
| `exclude.authors` | the PR/MR was opened by one of these usernames | case-insensitive exact match |
| `exclude.authors` | the PR/MR was opened by an author matching one of these patterns | case-insensitive glob |
| any key set to `[]` | clears the org-wide default for that key ([Configuration hierarchy](#configuration-hierarchy)) | - |

<Note>
Expand All @@ -107,6 +107,7 @@ exclude:
- "**/*.md"
authors:
- "dependabot[bot]" # exclude all PRs opened by dependabot
- "*-bot" # glob: exclude any author ending in "-bot"
```

<Note>
Expand All @@ -117,11 +118,11 @@ exclude:
</Note>

<Accordion title="Glob pattern syntax">
`exclude.branches`, `exclude.paths`, and `include.branches` (and their
org-wide equivalents) accept glob patterns mixed with literals: `*`, `**`,
`?`, and `{(a, b)}` brace expansion. Matching is case-insensitive. `[`, `]`,
and a leading `!` are literal, not special syntax. Each category allows up to
50 entries.
`exclude.branches`, `exclude.paths`, `exclude.authors`/`include.authors`, and
`include.branches` (and their org-wide equivalents) accept glob patterns mixed
with literals: `*`, `**`, `?`, and `{(a, b)}` brace expansion. Matching is
case-insensitive. `[`, `]`, and a leading `!` are literal, not special syntax.
Each category allows up to 50 entries.
</Accordion>

<Accordion title="Matching nested branches with * vs **">
Expand Down Expand Up @@ -154,8 +155,9 @@ include:
labels:
- security-review # only scan PRs labelled "security-review"
authors:
- alice # ...and were opened by Alice or Bob
- alice # ...and were opened by Alice, Bob, or a bot account
- bob
- "*-bot"
keywords:
- "please review" # ...and title contains "please review"
```
Expand All @@ -164,7 +166,7 @@ include:
| ------------------- | ---------------------------------------------------------------------------------------------- |
| `include.branches` | the PR/MR targets one of these branches (case-insensitive glob) |
| `include.labels` | the PR/MR carries at least one of these labels (case-insensitive exact match) |
| `include.authors` | the PR/MR was opened by one of these usernames (case-insensitive exact match) |
| `include.authors` | the PR/MR was opened by an author matching one of these patterns (case-insensitive glob) |
| `include.keywords` | the PR/MR title contains one of these strings (case-insensitive substring) |
| any key set to `[]` | clears the org-wide default for that key ([Configuration hierarchy](#configuration-hierarchy)) |

Expand Down
2 changes: 1 addition & 1 deletion platform/organization-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Choose which pull and merge requests Hacktron scans by default, across four cate
| -------- | ------------------------------------------------- |
| Branches | Glob pattern, case-insensitive (e.g. `release/*`) |
| Labels | Exact name, case-insensitive |
| Authors | Exact username, case-insensitive |
| Authors | Glob pattern, case-insensitive (e.g. `*-bot`) |
| Keywords | Substring in the PR/MR title, case-insensitive |

<Note>
Expand Down