Skip to content

Update PR creation and ready-for-review trigger defaults #798

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
merged 3 commits into from
Oct 20, 2025
Merged

Update PR creation and ready-for-review trigger defaults #798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8624ced
Update PR creation and ready-for-review trigger defaults
vim-zz Oct 20, 2025
d974669
Improve trigger table with better column names and layout
vim-zz Oct 20, 2025
10e6402
Remove placeholder dashes in trigger conditions table
vim-zz Oct 20, 2025
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
32 changes: 16 additions & 16 deletions docs/execution-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,22 +63,22 @@ Additionally, the `on` keyword defines specific events that trigger automations.
The table below lists supported explicit triggers, categorized into those enabled by default and those that require manual activation.

<div class="trigger-details" markdown=1>
| Triggering event | Explicit Trigger :fontawesome-brands-github: | Default (implicit triggers) |
| --------------------------------------------------------------------- | -------------------------------------------- | ------------------------------ |
| Checks finished | - | When an automation uses the `wait_for_all_checks` action |
| Comment added | `comment_added` | when `pr.comment` in `.cm` |
| :fontawesome-brands-github: Comment edited | - | when `pr.comment` in `.cm` |
| Commit pushed | `commit` | `on` |
| Creating a PR | `pr_created` | `on` |
| Description changed | - | when `pr.description` in `.cm` |
| Label added | `label_added` | when `pr.label` in `.cm` |
| Label removed | `label_removed` | when `pr.label` in `.cm` |
| :fontawesome-brands-github: Merging the PR | `merge` | `off` |
| Title change | - | when `pr.title` in `.cm` |
| :fontawesome-brands-github: Transition from draft to ready for review | `pr_ready_for_review` | `off` |
| :fontawesome-brands-github: Transition from any state to closed | `pr_closed` | `off` |
| :fontawesome-brands-github: Transition from closed to open | `pr_reopened` | `off` |
| :fontawesome-brands-github: Transition from any state to approved | `pr_approved` | If there is an automation with one of the actions: `require-reviewers`, `set-required-approvals` or `merge`, or uses `pr.approvals` context variable |
| Triggering event | Explicit Trigger :fontawesome-brands-github: | Default | Conditions |
| --------------------------------------------------------------------- | -------------------------------------------- | ------- | ------------- |
| Checks finished | - | `on` | when an automation uses the `wait_for_all_checks` action |
| Comment added | `comment_added` | `on` | when `pr.comment` in `.cm` |
| :fontawesome-brands-github: Comment edited | - | `on` | when `pr.comment` in `.cm` |
| Commit pushed | `commit` | `on` | |
| Creating a PR | `pr_created` | `on` | when not a draft |
| Description changed | - | `on` | when `pr.description` in `.cm` |
| Label added | `label_added` | `on` | when `pr.label` in `.cm` |
| Label removed | `label_removed` | `on` | when `pr.label` in `.cm` |
| :fontawesome-brands-github: Merging the PR | `merge` | `off` | |
| Title change | - | `on` | when `pr.title` in `.cm` |
| Transition from draft to ready for review | `pr_ready_for_review` | `on` | |
| :fontawesome-brands-github: Transition from any state to closed | `pr_closed` | `off` | |
| :fontawesome-brands-github: Transition from closed to open | `pr_reopened` | `off` | |
| :fontawesome-brands-github: Transition from any state to approved | `pr_approved` | `on` | If there is an automation with one of the actions: `require-reviewers`, `set-required-approvals` or `merge`, or uses `pr.approvals` context variable |
</div>

Explicit triggers are set independently per each automation block and can be configured at the file level, specific to each automation separately or in combination. If triggers are listed at the file level **and** specific automation, the automation will be triggered according to both triggers.
Expand Down
2 changes: 1 addition & 1 deletion docs/stylesheets/extra.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ div.filter-details th:nth-child(1){
}

div.trigger-details th:nth-child(2){
width: 30%;
width: 25%;
}

div.commands-details th:nth-child(1){
Expand Down