Fixed environment ref in GitHub becomes stale on follow-up PR deploym…

…ents.

.lagoon.yml

@@ -25,7 +25,16 @@ tasks:
     - run:
         name: Notify about pre-deployment.
         command: |
-          if [ -n "$LAGOON_PR_NUMBER" ]; then export VORTEX_NOTIFY_REF=$LAGOON_PR_NUMBER;export VORTEX_NOTIFY_SHA=${LAGOON_PR_HEAD_SHA#origin/};export VORTEX_NOTIFY_BRANCH=$LAGOON_PR_HEAD_BRANCH;else export VORTEX_NOTIFY_REF=$LAGOON_GIT_BRANCH;export VORTEX_NOTIFY_SHA=$LAGOON_GIT_SHA;export VORTEX_NOTIFY_BRANCH=$LAGOON_GIT_BRANCH;fi
+          if [ -n "$LAGOON_PR_NUMBER" ]; then
+            export VORTEX_NOTIFY_REF=$LAGOON_PR_NUMBER
+            export VORTEX_NOTIFY_SHA=${LAGOON_PR_HEAD_SHA#origin/}
+            export VORTEX_NOTIFY_BRANCH=$LAGOON_PR_HEAD_BRANCH
+            export VORTEX_NOTIFY_PR_NUMBER="${LAGOON_PR_NUMBER:-}"
+          else
+            export VORTEX_NOTIFY_REF=$LAGOON_GIT_BRANCH
+            export VORTEX_NOTIFY_SHA=$LAGOON_GIT_SHA
+            export VORTEX_NOTIFY_BRANCH=$LAGOON_GIT_BRANCH
+          fi
           VORTEX_NOTIFY_PROJECT=$LAGOON_PROJECT \
           VORTEX_NOTIFY_ENVIRONMENT_URL=$LAGOON_ROUTE \
           VORTEX_NOTIFY_EVENT=pre_deployment ./scripts/vortex/notify.sh || true
@@ -88,7 +97,16 @@ tasks:
     - run:
         name: Send deployment notifications
         command: |
-          if [ -n "$LAGOON_PR_NUMBER" ]; then export VORTEX_NOTIFY_REF=$LAGOON_PR_NUMBER; export VORTEX_NOTIFY_SHA=${LAGOON_PR_HEAD_SHA#origin/}; export VORTEX_NOTIFY_BRANCH=$LAGOON_PR_HEAD_BRANCH; else export VORTEX_NOTIFY_REF=$LAGOON_GIT_BRANCH; export VORTEX_NOTIFY_SHA=$LAGOON_GIT_SHA; export VORTEX_NOTIFY_BRANCH=$LAGOON_GIT_BRANCH; fi
+          if [ -n "$LAGOON_PR_NUMBER" ]; then
+            export VORTEX_NOTIFY_REF=$LAGOON_PR_NUMBER
+            export VORTEX_NOTIFY_SHA=${LAGOON_PR_HEAD_SHA#origin/}
+            export VORTEX_NOTIFY_BRANCH=$LAGOON_PR_HEAD_BRANCH
+            export VORTEX_NOTIFY_PR_NUMBER="${LAGOON_PR_NUMBER:-}"
+          else
+            export VORTEX_NOTIFY_REF=$LAGOON_GIT_BRANCH
+            export VORTEX_NOTIFY_SHA=$LAGOON_GIT_SHA
+            export VORTEX_NOTIFY_BRANCH=$LAGOON_GIT_BRANCH
+          fi
           VORTEX_NOTIFY_EVENT=post_deployment \
           VORTEX_NOTIFY_PROJECT=$LAGOON_PROJECT \
           VORTEX_NOTIFY_ENVIRONMENT_URL=$LAGOON_ROUTE \

.vortex/docs/content/workflows/variables.mdx

@@ -1456,6 +1456,16 @@ Default value: `UNDEFINED`
 
 Defined in: `scripts/vortex/notify-webhook.sh`, `scripts/vortex/notify.sh`
 
+### `VORTEX_NOTIFY_PR_NUMBER`
+
+Deployment PR number.
+
+If set, the environment type will be set to 'pr-[`${VORTEX_NOTIFY_PR_NUMBER}`](#vortex_notify_pr_number)'.
+
+Default value: `UNDEFINED`
+
+Defined in: `scripts/vortex/notify-github.sh`
+
 ### `VORTEX_NOTIFY_REF`
 
 Git reference to notify about.

.vortex/tests/bats/notify.bats

@@ -139,6 +139,36 @@ load _helper.bash
   popd >/dev/null || exit 1
 }
 
+@test "Notify: github, pre_deployment, PR" {
+  pushd "${LOCAL_REPO_DIR}" >/dev/null || exit 1
+
+  app_id="123456789"
+
+  declare -a STEPS=(
+    "Started dispatching notifications."
+    "Started GitHub notification for pre_deployment event."
+    "@curl -X POST -H Authorization: token token12345 -H Accept: application/vnd.github.v3+json -s https://api.github.com/repos/myorg/myrepo/deployments -d {\"ref\":\"existingbranch\", \"environment\": \"PR-123\", \"auto_merge\": false} # {\"id\": \"${app_id}\", \"othervar\": \"54321\"}"
+    "Marked deployment as started."
+    "Finished GitHub notification for pre_deployment event."
+    "Finished dispatching notifications."
+  )
+
+  mocks="$(run_steps "setup")"
+
+  export VORTEX_NOTIFY_CHANNELS="github"
+  export VORTEX_NOTIFY_EVENT="pre_deployment"
+  export VORTEX_NOTIFY_GITHUB_TOKEN="token12345"
+  export VORTEX_NOTIFY_REPOSITORY="myorg/myrepo"
+  export VORTEX_NOTIFY_BRANCH="existingbranch"
+  export VORTEX_NOTIFY_PR_NUMBER="123"
+  run ./scripts/vortex/notify.sh
+  assert_success
+
+  run_steps "assert" "${mocks[@]}"
+
+  popd >/dev/null || exit 1
+}
+
 @test "Notify: github, pre_deployment, longer ID" {
   pushd "${LOCAL_REPO_DIR}" >/dev/null || exit 1
 

scripts/vortex/notify-github.sh

@@ -25,6 +25,11 @@ VORTEX_NOTIFY_REPOSITORY="${VORTEX_NOTIFY_REPOSITORY:-}"
 # Deployment reference branch.
 VORTEX_NOTIFY_BRANCH="${VORTEX_NOTIFY_BRANCH:-}"
 
+# Deployment PR number.
+#
+# If set, the environment type will be set to 'pr-${VORTEX_NOTIFY_PR_NUMBER}'.
+VORTEX_NOTIFY_PR_NUMBER="${VORTEX_NOTIFY_PR_NUMBER:-}"
+
 # The event to notify about. Can be 'pre_deployment' or 'post_deployment'.
 VORTEX_NOTIFY_EVENT="${VORTEX_NOTIFY_EVENT:-}"
 
@@ -72,6 +77,10 @@ extract_json_value() {
   php -r "\$data=json_decode(file_get_contents('php://stdin'), TRUE); isset(\$data[\"${key}\"]) ? print trim(json_encode(\$data[\"${key}\"], JSON_UNESCAPED_SLASHES), '\"') : exit(1);"
 }
 
+if [ "${VORTEX_NOTIFY_ENVIRONMENT_TYPE}" = "PR" ] && [ -n "${VORTEX_NOTIFY_PR_NUMBER}" ]; then
+  VORTEX_NOTIFY_ENVIRONMENT_TYPE="PR-${VORTEX_NOTIFY_PR_NUMBER}"
+fi
+
 if [ "${VORTEX_NOTIFY_EVENT}" = "pre_deployment" ]; then
   payload="$(curl \
     -X POST \