From 8624cedac83f8e06317f0f462685f47f58cf57cd Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Mon, 20 Oct 2025 11:34:17 +0300 Subject: [PATCH 1/3] Update PR creation and ready-for-review trigger defaults --- docs/execution-model.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/execution-model.md b/docs/execution-model.md index 64a60638..11e1a5f8 100644 --- a/docs/execution-model.md +++ b/docs/execution-model.md @@ -69,13 +69,13 @@ The table below lists supported explicit triggers, categorized into those enable | 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` | +| Creating a PR | `pr_created` | When not a draft | | 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` | +| 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` | If there is an automation with one of the actions: `require-reviewers`, `set-required-approvals` or `merge`, or uses `pr.approvals` context variable | From d974669f10912e627807ed141a385fc7d0ce5ca0 Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Mon, 20 Oct 2025 11:52:14 +0300 Subject: [PATCH 2/3] Improve trigger table with better column names and layout --- docs/execution-model.md | 32 ++++++++++++++++---------------- docs/stylesheets/extra.css | 2 +- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/execution-model.md b/docs/execution-model.md index 11e1a5f8..9bf9d618 100644 --- a/docs/execution-model.md +++ b/docs/execution-model.md @@ -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.
-| 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` | When not a draft | -| 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` | -| 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` | 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 |
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. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 5911d6b8..a31d4da6 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -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){ From 10e64022ca8ce44671d82293cb655c41ad1ae7eb Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Mon, 20 Oct 2025 11:59:27 +0300 Subject: [PATCH 3/3] Remove placeholder dashes in trigger conditions table --- docs/execution-model.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/execution-model.md b/docs/execution-model.md index 9bf9d618..32c5a7ec 100644 --- a/docs/execution-model.md +++ b/docs/execution-model.md @@ -68,16 +68,16 @@ The table below lists supported explicit triggers, categorized into those enable | 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` | - | +| 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` | - | +| :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` | - | +| 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 |