[#1428] Updated deployment bypass mechanism to use list-based variables.

AlexSkrypnyk · AlexSkrypnyk · commit 33fdfc5f45ae · 2025-11-12T10:10:57.000+11:00
- Replaced individual `VORTEX_DEPLOY_SKIP_PR_&lt;NUMBER&gt;` and `VORTEX_DEPLOY_SKIP_BRANCH_&lt;SAFE_BRANCH&gt;` variables with comma-separated list variables
- Added `VORTEX_DEPLOY_SKIP_PRS` for PR numbers (single or comma-separated)
- Added `VORTEX_DEPLOY_SKIP_BRANCHES` for branch names (single or comma-separated)
- Updated `scripts/vortex/deploy.sh` with new list-based skip logic
- Updated PHPUnit tests to cover new skip scenarios
- Updated documentation for deployment workflows and variables
- Updated GitHub Actions workflow to include new environment variables
- Updated CI variables configuration
- Updated installer baseline fixtures

  This is a breaking change. Projects using the old mechanism will need to migrate from:
  VORTEX_DEPLOY_SKIP_PR_123: "1"
  VORTEX_DEPLOY_SKIP_BRANCH_FEATURE_TEST: "1"

  To:
  VORTEX_DEPLOY_ALLOW_SKIP: "1"
  VORTEX_DEPLOY_SKIP_PRS: "123"
  VORTEX_DEPLOY_SKIP_BRANCHES: "feature/test"
diff --git a/.github/workflows/build-test-deploy.yml b/.github/workflows/build-test-deploy.yml
@@ -475,5 +475,8 @@ jobs:
           VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME: ${{ vars.VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME }}
           VORTEX_DEPLOY_WEBHOOK_URL: ${{ vars.VORTEX_DEPLOY_WEBHOOK_URL }}
           VORTEX_DEPLOY_SKIP: ${{ vars.VORTEX_DEPLOY_SKIP }}
+          VORTEX_DEPLOY_ALLOW_SKIP: ${{ vars.VORTEX_DEPLOY_ALLOW_SKIP }}
+          VORTEX_DEPLOY_SKIP_PRS: ${{ vars.VORTEX_DEPLOY_SKIP_PRS }}
+          VORTEX_DEPLOY_SKIP_BRANCHES: ${{ vars.VORTEX_DEPLOY_SKIP_BRANCHES }}
         timeout-minutes: 30
   #;> DEPLOYMENT
diff --git a/.vortex/docs/.utils/variables/extra/ci.variables.sh b/.vortex/docs/.utils/variables/extra/ci.variables.sh
@@ -6,6 +6,15 @@
 # Skip all deployments.
 VORTEX_DEPLOY_SKIP=
 
+# Flag to allow skipping of a deployment using additional flags.
+VORTEX_DEPLOY_ALLOW_SKIP=
+
+# Pull request numbers to skip deployment for (single value or comma-separated list).
+VORTEX_DEPLOY_SKIP_PRS=
+
+# Branch names to skip deployment for (single value or comma-separated list).
+VORTEX_DEPLOY_SKIP_BRANCHES=
+
 # Proceed with container image deployment after it was exported.
 VORTEX_EXPORT_DB_CONTAINER_REGISTRY_DEPLOY_PROCEED=
 
diff --git a/.vortex/docs/content/workflows/deployment.mdx b/.vortex/docs/content/workflows/deployment.mdx
@@ -75,31 +75,45 @@ variable to `1`.
 This is especially useful in continuous integration pipelines where you may want to build and test
 without triggering a deployment.
 
-### Skipping deployments for a specific Pull Requests or branches
+### Skipping deployments for specific Pull Requests or branches
 
-To skip a specific Pull Request or branch using the `$VORTEX_DEPLOY_SKIP`
-variable, you would define additional environment variables with a specific
-naming convention in your continuous integration pipeline configuration.
+To skip specific Pull Requests or branches, set `$VORTEX_DEPLOY_ALLOW_SKIP` to `1`
+and provide lists in the following variables:
 
-Here's an example of how this can be done:
+#### Skipping specific Pull Requests
 
-#### Skipping a specific Pull Request
+Set `$VORTEX_DEPLOY_SKIP_PRS` to a single PR number or comma-separated list:
 
-   Suppose you want to skip the deployment for Pull Request number 42. You would
-   set the following environment variable:
+```bash
+# Skip a single PR
+VORTEX_DEPLOY_ALLOW_SKIP=1
+VORTEX_DEPLOY_SKIP_PRS=42
 
-   ```bash
-   VORTEX_DEPLOY_SKIP_PR_42=1
-   ```
+# Skip multiple PRs
+VORTEX_DEPLOY_ALLOW_SKIP=1
+VORTEX_DEPLOY_SKIP_PRS=42,123,456
+```
 
-#### Skipping a specific branch
+#### Skipping specific branches
 
-   Suppose you want to skip the deployment for a branch named `feature-x`. You
-   would first create a "safe" version of the branch name by replacing any
-   special characters with underscores.
+Set `$VORTEX_DEPLOY_SKIP_BRANCHES` to a single branch name or comma-separated list:
 
-   Set the following environment variable:
+```bash
+# Skip a single branch
+VORTEX_DEPLOY_ALLOW_SKIP=1
+VORTEX_DEPLOY_SKIP_BRANCHES=feature/test
 
-   ```bash
-   VORTEX_DEPLOY_SKIP_BRANCH_FEATURE_X=1
-   ```
+# Skip multiple branches
+VORTEX_DEPLOY_ALLOW_SKIP=1
+VORTEX_DEPLOY_SKIP_BRANCHES=feature/test,hotfix/urgent,project/experimental
+```
+
+#### Combined usage
+
+You can use both variables together:
+
+```bash
+VORTEX_DEPLOY_ALLOW_SKIP=1
+VORTEX_DEPLOY_SKIP_PRS=42,123
+VORTEX_DEPLOY_SKIP_BRANCHES=feature/test,hotfix/urgent
+```
diff --git a/.vortex/docs/content/workflows/variables.mdx b/.vortex/docs/content/workflows/variables.mdx
@@ -852,7 +852,7 @@ Flag to allow skipping of a deployment using additional flags.
 
 Default value: `UNDEFINED`
 
-Defined or used in: `scripts/vortex/deploy.sh`
+Defined or used in: `CI config`, `scripts/vortex/deploy.sh`
 
 ### `VORTEX_DEPLOY_ARTIFACT_DST_BRANCH`
 
@@ -1042,6 +1042,22 @@ Default value: `UNDEFINED`
 
 Defined or used in: `CI config`
 
+### `VORTEX_DEPLOY_SKIP_BRANCHES`
+
+Branch names to skip deployment for (single value or comma-separated list).
+
+Default value: `UNDEFINED`
+
+Defined or used in: `CI config`, `scripts/vortex/deploy.sh`
+
+### `VORTEX_DEPLOY_SKIP_PRS`
+
+Pull request numbers to skip deployment for (single value or comma-separated list).
+
+Default value: `UNDEFINED`
+
+Defined or used in: `CI config`, `scripts/vortex/deploy.sh`
+
 ### `VORTEX_DEPLOY_SSH_FILE`
 
 Default SSH file used if custom fingerprint is not provided.
diff --git a/.vortex/installer/tests/Fixtures/install/_baseline/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/install/_baseline/.github/workflows/build-test-deploy.yml
@@ -438,4 +438,7 @@ jobs:
           VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME: ${{ vars.VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME }}
           VORTEX_DEPLOY_WEBHOOK_URL: ${{ vars.VORTEX_DEPLOY_WEBHOOK_URL }}
           VORTEX_DEPLOY_SKIP: ${{ vars.VORTEX_DEPLOY_SKIP }}
+          VORTEX_DEPLOY_ALLOW_SKIP: ${{ vars.VORTEX_DEPLOY_ALLOW_SKIP }}
+          VORTEX_DEPLOY_SKIP_PRS: ${{ vars.VORTEX_DEPLOY_SKIP_PRS }}
+          VORTEX_DEPLOY_SKIP_BRANCHES: ${{ vars.VORTEX_DEPLOY_SKIP_BRANCHES }}
         timeout-minutes: 30
diff --git a/.vortex/installer/tests/Fixtures/install/deploy_types_none_gha/.github/workflows/build-test-deploy.yml b/.vortex/installer/tests/Fixtures/install/deploy_types_none_gha/.github/workflows/build-test-deploy.yml
@@ -1,4 +1,4 @@
-@@ -369,73 +369,3 @@
+@@ -369,76 +369,3 @@
          timeout-minutes: 120 # Cancel the action after 15 minutes, regardless of whether a connection has been established.
          with:
            detached: true
@@ -71,4 +71,7 @@
 -          VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME: ${{ vars.VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME }}
 -          VORTEX_DEPLOY_WEBHOOK_URL: ${{ vars.VORTEX_DEPLOY_WEBHOOK_URL }}
 -          VORTEX_DEPLOY_SKIP: ${{ vars.VORTEX_DEPLOY_SKIP }}
+-          VORTEX_DEPLOY_ALLOW_SKIP: ${{ vars.VORTEX_DEPLOY_ALLOW_SKIP }}
+-          VORTEX_DEPLOY_SKIP_PRS: ${{ vars.VORTEX_DEPLOY_SKIP_PRS }}
+-          VORTEX_DEPLOY_SKIP_BRANCHES: ${{ vars.VORTEX_DEPLOY_SKIP_BRANCHES }}
 -        timeout-minutes: 30
diff --git a/.vortex/tests/phpunit/Functional/DeploymentTest.php b/.vortex/tests/phpunit/Functional/DeploymentTest.php
@@ -75,7 +75,7 @@ public function testDeploymentSkipFlags(): void {
       'VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS' => '200',
     ]);
 
-    $this->logSubstep('Subtest 2: Run deployment with skip flag but no per-branch skip');
+    $this->logSubstep('Subtest 2: Run deployment with ALLOW_SKIP but no skip lists');
     $this->cmd('ahoy deploy', [
       '* Found flag to skip a deployment.',
       '* Started WEBHOOK deployment.',
@@ -88,39 +88,99 @@ public function testDeploymentSkipFlags(): void {
       'VORTEX_DEPLOY_ALLOW_SKIP' => '1',
     ]);
 
-    $this->logSubstep('Subtest 3: Run deployment with per-branch skip flag');
+    $this->logSubstep('Subtest 3: Skip deployment for single PR');
     $this->cmd('ahoy deploy', [
       '* Found flag to skip a deployment.',
-      '* Found skip variable VORTEX_DEPLOY_SKIP_BRANCH_FEATURE_TEST',
+      '* Found PR 123 in skip list.',
       '* Skipping deployment webhook.',
       '! Started WEBHOOK deployment.',
-      '! Finished WEBHOOK deployment.',
-    ], txt: 'Deployment should be skipped for feature/test branch', env: [
+    ], txt: 'Deployment should be skipped for single PR', env: [
       'VORTEX_DEPLOY_TYPES' => 'webhook',
       'VORTEX_DEPLOY_WEBHOOK_URL' => 'https://www.example.com',
       'VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS' => '200',
       'VORTEX_DEPLOY_ALLOW_SKIP' => '1',
-      'VORTEX_DEPLOY_BRANCH' => 'feature/test',
-      'VORTEX_DEPLOY_SKIP_BRANCH_FEATURE_TEST' => '1',
+      'VORTEX_DEPLOY_PR' => '123',
+      'VORTEX_DEPLOY_SKIP_PRS' => '123',
     ]);
 
-    $this->logSubstep('Subtest 4: Run deployment with per-PR skip flag');
+    $this->logSubstep('Subtest 4: Skip deployment for PR in comma-separated list');
     $this->cmd('ahoy deploy', [
       '* Found flag to skip a deployment.',
-      '* Found skip variable VORTEX_DEPLOY_SKIP_PR_123',
+      '* Found PR 123 in skip list.',
       '* Skipping deployment webhook.',
       '! Started WEBHOOK deployment.',
-      '! Finished WEBHOOK deployment.',
-    ], txt: 'Deployment should be skipped for PR 123', env: [
+    ], txt: 'Deployment should be skipped for PR 123 in list', env: [
       'VORTEX_DEPLOY_TYPES' => 'webhook',
       'VORTEX_DEPLOY_WEBHOOK_URL' => 'https://www.example.com',
       'VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS' => '200',
       'VORTEX_DEPLOY_ALLOW_SKIP' => '1',
       'VORTEX_DEPLOY_PR' => '123',
-      'VORTEX_DEPLOY_SKIP_PR_123' => '1',
+      'VORTEX_DEPLOY_SKIP_PRS' => '123,456,789',
     ]);
 
-    $this->logSubstep('Subtest 5: Run deployment without skip flag but with per-PR');
+    $this->logSubstep('Subtest 5: Allow deployment for PR not in skip list');
+    $this->cmd('ahoy deploy', [
+      '* Found flag to skip a deployment.',
+      '* Started WEBHOOK deployment.',
+      '* Finished WEBHOOK deployment.',
+      '! Found PR 999 in skip list.',
+      '! Skipping deployment webhook.',
+    ], txt: 'Deployment should proceed for PR 999 not in skip list', env: [
+      'VORTEX_DEPLOY_TYPES' => 'webhook',
+      'VORTEX_DEPLOY_WEBHOOK_URL' => 'https://www.example.com',
+      'VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS' => '200',
+      'VORTEX_DEPLOY_ALLOW_SKIP' => '1',
+      'VORTEX_DEPLOY_PR' => '999',
+      'VORTEX_DEPLOY_SKIP_PRS' => '123,456,789',
+    ]);
+
+    $this->logSubstep('Subtest 6: Skip deployment for single branch');
+    $this->cmd('ahoy deploy', [
+      '* Found flag to skip a deployment.',
+      '* Found branch feature/test in skip list.',
+      '* Skipping deployment webhook.',
+      '! Started WEBHOOK deployment.',
+    ], txt: 'Deployment should be skipped for single branch', env: [
+      'VORTEX_DEPLOY_TYPES' => 'webhook',
+      'VORTEX_DEPLOY_WEBHOOK_URL' => 'https://www.example.com',
+      'VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS' => '200',
+      'VORTEX_DEPLOY_ALLOW_SKIP' => '1',
+      'VORTEX_DEPLOY_BRANCH' => 'feature/test',
+      'VORTEX_DEPLOY_SKIP_BRANCHES' => 'feature/test',
+    ]);
+
+    $this->logSubstep('Subtest 7: Skip deployment for branch in comma-separated list');
+    $this->cmd('ahoy deploy', [
+      '* Found flag to skip a deployment.',
+      '* Found branch feature/test in skip list.',
+      '* Skipping deployment webhook.',
+      '! Started WEBHOOK deployment.',
+    ], txt: 'Deployment should be skipped for branch in list', env: [
+      'VORTEX_DEPLOY_TYPES' => 'webhook',
+      'VORTEX_DEPLOY_WEBHOOK_URL' => 'https://www.example.com',
+      'VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS' => '200',
+      'VORTEX_DEPLOY_ALLOW_SKIP' => '1',
+      'VORTEX_DEPLOY_BRANCH' => 'feature/test',
+      'VORTEX_DEPLOY_SKIP_BRANCHES' => 'feature/test,hotfix/urgent,project/experimental',
+    ]);
+
+    $this->logSubstep('Subtest 8: Allow deployment for branch not in skip list');
+    $this->cmd('ahoy deploy', [
+      '* Found flag to skip a deployment.',
+      '* Started WEBHOOK deployment.',
+      '* Finished WEBHOOK deployment.',
+      '! Found branch develop in skip list.',
+      '! Skipping deployment webhook.',
+    ], txt: 'Deployment should proceed for branch not in skip list', env: [
+      'VORTEX_DEPLOY_TYPES' => 'webhook',
+      'VORTEX_DEPLOY_WEBHOOK_URL' => 'https://www.example.com',
+      'VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS' => '200',
+      'VORTEX_DEPLOY_ALLOW_SKIP' => '1',
+      'VORTEX_DEPLOY_BRANCH' => 'develop',
+      'VORTEX_DEPLOY_SKIP_BRANCHES' => 'feature/test,hotfix/urgent',
+    ]);
+
+    $this->logSubstep('Subtest 9: Run deployment without ALLOW_SKIP despite skip lists');
     $this->cmd('ahoy deploy', [
       '* Started WEBHOOK deployment.',
       '* Finished WEBHOOK deployment.',
@@ -131,7 +191,9 @@ public function testDeploymentSkipFlags(): void {
       'VORTEX_DEPLOY_WEBHOOK_URL' => 'https://www.example.com',
       'VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS' => '200',
       'VORTEX_DEPLOY_PR' => '123',
-      'VORTEX_DEPLOY_SKIP_PR_123' => '1',
+      'VORTEX_DEPLOY_SKIP_PRS' => '123',
+      'VORTEX_DEPLOY_BRANCH' => 'feature/test',
+      'VORTEX_DEPLOY_SKIP_BRANCHES' => 'feature/test',
     ]);
 
     $this->logStepFinish();
diff --git a/scripts/vortex/deploy.sh b/scripts/vortex/deploy.sh
@@ -72,36 +72,31 @@ fi
 if [ "${VORTEX_DEPLOY_ALLOW_SKIP:-}" = "1" ]; then
   note "Found flag to skip a deployment."
 
-  if [ -n "${VORTEX_DEPLOY_PR}" ]; then
-    # Allow skipping deployment by providing `$VORTEX_DEPLOY_SKIP_PR_<NUMBER>`
-    # variable with value set to "1", where `<NUMBER>` is a PR number name with
-    # spaces, hyphens and forward slashes replaced with underscores and then
-    # capitalised.
+  if [ -n "${VORTEX_DEPLOY_PR}" ] && [ -n "${VORTEX_DEPLOY_SKIP_PRS:-}" ]; then
+    # Allow skipping deployment by providing `$VORTEX_DEPLOY_SKIP_PRS` variable
+    # with PR numbers as a single value or comma-separated list.
     #
-    # Example:
-    # For PR named 'pr-123', the variable name is $VORTEX_DEPLOY_SKIP_PR_123
-    pr_skip_var="VORTEX_DEPLOY_SKIP_PR_${VORTEX_DEPLOY_PR}"
-    if [ -n "${!pr_skip_var}" ]; then
-      note "Found skip variable ${pr_skip_var} for PR ${VORTEX_DEPLOY_PR}."
+    # Examples:
+    # VORTEX_DEPLOY_SKIP_PRS=123
+    # VORTEX_DEPLOY_SKIP_PRS=123,456,789
+    if echo ",${VORTEX_DEPLOY_SKIP_PRS}," | grep -q ",${VORTEX_DEPLOY_PR},"; then
+      note "Found PR ${VORTEX_DEPLOY_PR} in skip list."
       note "Skipping deployment ${VORTEX_DEPLOY_TYPES}."
       exit 0
     fi
   fi
 
-  if [ -n "${VORTEX_DEPLOY_BRANCH:-}" ]; then
-    # Allow skipping deployment by providing 'VORTEX_DEPLOY_SKIP_BRANCH_<SAFE_BRANCH>'
-    # variable with value set to "1", where <SAFE_BRANCH> is a branch name with
-    # spaces, hyphens and forward slashes replaced with underscores and then
-    # capitalised.
+  if [ -n "${VORTEX_DEPLOY_BRANCH:-}" ] && [ -n "${VORTEX_DEPLOY_SKIP_BRANCHES:-}" ]; then
+    # Allow skipping deployment by providing `$VORTEX_DEPLOY_SKIP_BRANCHES`
+    # variable with branch names as a single value or comma-separated list.
     #
-    # Example:
-    # For 'main' branch, the variable name is $VORTEX_DEPLOY_SKIP_BRANCH_MAIN
-    # For 'feature/my complex feature-123 update' branch, the variable name
-    # is $VORTEX_DEPLOY_SKIP_BRANCH_MY_COMPLEX_FEATURE_123_UPDATE
-    safe_branch_name="$(echo "${VORTEX_DEPLOY_BRANCH}" | tr -d '\n' | tr '[:space:]' '_' | tr '-' '_' | tr '/' '_' | tr -cd '[:alnum:]_' | tr '[:lower:]' '[:upper:]')"
-    branch_skip_var="VORTEX_DEPLOY_SKIP_BRANCH_${safe_branch_name}"
-    if [ -n "${!branch_skip_var:-}" ]; then
-      note "Found skip variable ${branch_skip_var} for branch ${VORTEX_DEPLOY_BRANCH}."
+    # Branch names must match exactly as they appear in the repository.
+    #
+    # Examples:
+    # VORTEX_DEPLOY_SKIP_BRANCHES=feature/test
+    # VORTEX_DEPLOY_SKIP_BRANCHES=feature/test,hotfix/urgent,project/experimental
+    if echo ",${VORTEX_DEPLOY_SKIP_BRANCHES}," | grep -qF ",${VORTEX_DEPLOY_BRANCH},"; then
+      note "Found branch ${VORTEX_DEPLOY_BRANCH} in skip list."
       note "Skipping deployment ${VORTEX_DEPLOY_TYPES}."
       exit 0
     fi
