From 4937ee4b755b2f0afd8bda2282ea8ae285fff284 Mon Sep 17 00:00:00 2001 From: Alex Skrypnyk Date: Thu, 26 Mar 2026 20:20:34 +1100 Subject: [PATCH] [#2173] Added per-channel branch filtering for notifications. Part 2. --- .vortex/docs/content/deployment/notifications.mdx | 4 ++-- .vortex/docs/content/development/variables.mdx | 2 +- .vortex/tests/bats/unit/notify-newrelic.bats | 8 ++++---- scripts/vortex/notify-newrelic.sh | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.vortex/docs/content/deployment/notifications.mdx b/.vortex/docs/content/deployment/notifications.mdx index e521e38a7..1c8710791 100644 --- a/.vortex/docs/content/deployment/notifications.mdx +++ b/.vortex/docs/content/deployment/notifications.mdx @@ -60,7 +60,7 @@ For example, to restrict New Relic notifications to only `main` and `staging`: VORTEX_NOTIFY_NEWRELIC_BRANCHES=main,staging ``` -New Relic defaults to `main,master`. All other channels default to no filter. +New Relic defaults to `main,master,develop`. All other channels default to no filter. ## Message templates and tokens @@ -202,7 +202,7 @@ in development or feature branch environments. | `VORTEX_NOTIFY_NEWRELIC_CHANGELOG` | No | Description | `.env` | Deployment changelog | | `VORTEX_NOTIFY_NEWRELIC_USER` | No | `Deployment robot` | `.env` | User performing deployment | | `VORTEX_NOTIFY_NEWRELIC_ENDPOINT` | No | `https://api.newrelic.com/v2` | `.env` | API endpoint | -| `VORTEX_NOTIFY_NEWRELIC_BRANCHES` | No | `main,master` | `.env` | Restrict to specific branches (comma-separated) | +| `VORTEX_NOTIFY_NEWRELIC_BRANCHES` | No | `main,master,develop` | `.env` | Restrict to specific branches (comma-separated) | ### Example diff --git a/.vortex/docs/content/development/variables.mdx b/.vortex/docs/content/development/variables.mdx index a8b242b4e..471b8ca64 100644 --- a/.vortex/docs/content/development/variables.mdx +++ b/.vortex/docs/content/development/variables.mdx @@ -351,7 +351,7 @@ The list below is automatically generated with [Shellvar](https://github.com/ale | `VORTEX_NOTIFY_NEWRELIC_APIKEY` | NewRelic API key, usually of type 'USER'.

@see https://www.vortextemplate.com/docs/deployment/notifications#new-relic | `UNDEFINED` | `ACQUIA ENVIRONMENT`, `LAGOON ENVIRONMENT` | | `VORTEX_NOTIFY_NEWRELIC_APPID` | New Relic notification application ID (auto-discovered if not provided).

Will be discovered automatically from application name if not provided. | `UNDEFINED` | `scripts/vortex/notify-newrelic.sh` | | `VORTEX_NOTIFY_NEWRELIC_APP_NAME` | New Relic notification application name as it appears in the dashboard. | `${VORTEX_NOTIFY_NEWRELIC_PROJECT}-${VORTEX_NOTIFY_NEWRELIC_LABEL}` | `scripts/vortex/notify-newrelic.sh` | -| `VORTEX_NOTIFY_NEWRELIC_BRANCHES` | New Relic notification branch filter.

Comma-separated list of branch names. When set, New Relic notifications are only sent for deployments on the listed branches. When empty, no filtering is applied. | `main,master` | `scripts/vortex/notify-newrelic.sh` | +| `VORTEX_NOTIFY_NEWRELIC_BRANCHES` | New Relic notification branch filter.

Comma-separated list of branch names. When set, New Relic notifications are only sent for deployments on the listed branches. When empty, no filtering is applied. | `main,master,develop` | `scripts/vortex/notify-newrelic.sh` | | `VORTEX_NOTIFY_NEWRELIC_CHANGELOG` | New Relic notification deployment changelog. Defaults to the description. | `UNDEFINED` | `scripts/vortex/notify-newrelic.sh` | | `VORTEX_NOTIFY_NEWRELIC_DESCRIPTION` | New Relic notification deployment description template. Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url% | `UNDEFINED` | `scripts/vortex/notify-newrelic.sh` | | `VORTEX_NOTIFY_NEWRELIC_ENABLED` | Flag to enable New Relic notifications. Set to "true" (not "`1`") in environments where New Relic is configured. | `${NEWRELIC_ENABLED}` | `scripts/vortex/notify-newrelic.sh` | diff --git a/.vortex/tests/bats/unit/notify-newrelic.bats b/.vortex/tests/bats/unit/notify-newrelic.bats index c86a49e6c..e668e31bb 100644 --- a/.vortex/tests/bats/unit/notify-newrelic.bats +++ b/.vortex/tests/bats/unit/notify-newrelic.bats @@ -109,17 +109,17 @@ load ../_helper.bash export VORTEX_NOTIFY_NEWRELIC_ENABLED=true export VORTEX_NOTIFY_PROJECT="testproject" export VORTEX_NOTIFY_NEWRELIC_USER_KEY="key1234" - export VORTEX_NOTIFY_BRANCH="develop" + export VORTEX_NOTIFY_BRANCH="feature/test" export VORTEX_NOTIFY_SHA="abc123def456" - export VORTEX_NOTIFY_LABEL="develop" + export VORTEX_NOTIFY_LABEL="feature/test" export VORTEX_NOTIFY_ENVIRONMENT_URL="https://test.example.com" - # VORTEX_NOTIFY_NEWRELIC_BRANCHES defaults to "main,master" + # VORTEX_NOTIFY_NEWRELIC_BRANCHES defaults to "main,master,develop" run ./scripts/vortex/notify.sh assert_success assert_output_contains "Started dispatching notifications." - assert_output_contains "Skipping New Relic notification for branch 'develop'." + assert_output_contains "Skipping New Relic notification for branch 'feature/test'." assert_output_not_contains "Started New Relic notification." assert_output_contains "Finished dispatching notifications." diff --git a/scripts/vortex/notify-newrelic.sh b/scripts/vortex/notify-newrelic.sh index 8762ee3fd..8499b06e7 100755 --- a/scripts/vortex/notify-newrelic.sh +++ b/scripts/vortex/notify-newrelic.sh @@ -75,7 +75,7 @@ VORTEX_NOTIFY_NEWRELIC_EVENT="${VORTEX_NOTIFY_NEWRELIC_EVENT:-${VORTEX_NOTIFY_EV # Comma-separated list of branch names. When set, New Relic notifications # are only sent for deployments on the listed branches. When empty, no # filtering is applied. -VORTEX_NOTIFY_NEWRELIC_BRANCHES="${VORTEX_NOTIFY_NEWRELIC_BRANCHES:-main,master}" +VORTEX_NOTIFY_NEWRELIC_BRANCHES="${VORTEX_NOTIFY_NEWRELIC_BRANCHES:-main,master,develop}" # ------------------------------------------------------------------------------