From 8ad09517abcdfb8997ab02920b7a1cefd252b5d5 Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Mon, 3 Nov 2025 15:43:49 +0200 Subject: [PATCH] Update execution model trigger conditions Standardize condition descriptions to consistently reference context usage rather than specific properties. Move GitHub icons to the end of trigger names for better readability. --- docs/execution-model.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/execution-model.md b/docs/execution-model.md index 71013284..2c8257ae 100644 --- a/docs/execution-model.md +++ b/docs/execution-model.md @@ -66,19 +66,19 @@ The table below lists supported explicit triggers, categorized into those enable | 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 | +| Comment added | `comment_added` | `on` | when `pr` context is used in `.cm` | +| Comment edited :fontawesome-brands-github: | - | `on` | when `pr` context is used in `.cm` | +| Commit pushed | `commit` | `on` | | +| Creating a PR | `pr_created` | `on` | when not a draft | +| Description changed | - | `on` | when `pr` context is used in `.cm` | +| Label added | `label_added` | `on` | when `pr` context is used in `.cm` | +| Label removed | `label_removed` | `on` | when `pr` context is used in `.cm` | +| Merging the PR :fontawesome-brands-github: | `merge` | `off` | | +| Title changed | - | `on` | when `pr` context is used in `.cm` | +| Transition from draft to ready for review | `pr_ready_for_review` | `on` | | +| Transition from any state to closed :fontawesome-brands-github: | `pr_closed` | `off` | | +| Transition from closed to open :fontawesome-brands-github: | `pr_reopened` | `off` | | +| Transition from any state to approved :fontawesome-brands-github: | `pr_approved` | `on` | when actions `require-reviewers`, `set-required-approvals`, or `merge` are used, or when `pr` context is used in `.cm` | 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.