From eef91aca4349e758c0187804ec3576191539cc11 Mon Sep 17 00:00:00 2001 From: PavelLinearB Date: Thu, 14 Mar 2024 14:27:01 +0200 Subject: [PATCH 1/2] added ready_for_review, closed and opened triggers --- docs/changelog.md | 7 +++++++ docs/execution-model.md | 26 ++++++++++++++------------ 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 8a672083..c012cc52 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,6 +1,13 @@ # /:\\ gitStream Changelog All notable changes to this project will be documented in this file. + +### 2024.3.14 +- Added the following explicit triggers: + - `pr_ready_for_review` + - `pr_closed` + - `pr_reopened` + ### 2024.3.7 - Triggering on comment edits - Added support for `request-changes` action in GitLab diff --git a/docs/execution-model.md b/docs/execution-model.md index 43e5f0a4..bcdc430b 100644 --- a/docs/execution-model.md +++ b/docs/execution-model.md @@ -25,18 +25,20 @@ Use explicit triggers to enhance the control and customization of automations in Add the `on` keyword to the file and/or to a specific automation to define explicit triggers. gitStream supports the following explicit triggers: -| Triggering event | Explicit Trigger :fontawesome-brands-github: | Default (implicit triggers) | -| ------------------------------------------------------- | -------------------------------------------- | ------------------------------ | -| Creating a PR | `pr_created` | `on` | -| Commit | `commit` | `on` | -| Adding label | `label_added` | when `pr.label` in `.cm` | -| Removing label | `label_removed` | when `pr.label` in `.cm` | -| Merging the PR | `merge` | `off` | -| Adding new comment | `comment_added` | when `pr.comment` in `.cm` | -| :fontawesome-brands-github: Editing an existing comment | - | when `pr.comment` in `.cm` | -| Title change | - | when `pr.title` in `.cm` | -| Description change | - | when `pr.description` in `.cm` | - +| Triggering event | Explicit Trigger :fontawesome-brands-github: | Default (implicit triggers) | +| --------------------------------------------------------------------- | -------------------------------------------- | ------------------------------ | +| Creating a PR | `pr_created` | `on` | +| Commit | `commit` | `on` | +| Adding label | `label_added` | when `pr.label` in `.cm` | +| Removing label | `label_removed` | when `pr.label` in `.cm` | +| Merging the PR | `merge` | `off` | +| Adding new comment | `comment_added` | when `pr.comment` in `.cm` | +| :fontawesome-brands-github: Editing an existing comment | - | when `pr.comment` in `.cm` | +| Title change | - | when `pr.title` in `.cm` | +| Description change | - | when `pr.description` 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` | Explicit triggers are set independently per each automation block and can be configured at the file level, specific to each automation separately or in a combination of the two. If triggers are listed at the file level **and** specific automation, the automation will be triggered according to both triggers. If an automation block does not have explicit triggers configured, it will be triggered according to the default (implicit) triggers. From c7b8653c55b6becb4fd52a9eb897086a3f7a3572 Mon Sep 17 00:00:00 2001 From: PavelLinearB Date: Thu, 14 Mar 2024 14:30:37 +0200 Subject: [PATCH 2/2] merge is only for gh --- docs/execution-model.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/execution-model.md b/docs/execution-model.md index bcdc430b..5921bfe7 100644 --- a/docs/execution-model.md +++ b/docs/execution-model.md @@ -31,7 +31,7 @@ gitStream supports the following explicit triggers: | Commit | `commit` | `on` | | Adding label | `label_added` | when `pr.label` in `.cm` | | Removing label | `label_removed` | when `pr.label` in `.cm` | -| Merging the PR | `merge` | `off` | +| :fontawesome-brands-github: Merging the PR | `merge` | `off` | | Adding new comment | `comment_added` | when `pr.comment` in `.cm` | | :fontawesome-brands-github: Editing an existing comment | - | when `pr.comment` in `.cm` | | Title change | - | when `pr.title` in `.cm` |