Enable retry of successful deployment steps (#311)

seek-oss · Jan 7, 2021 · 2d2bf99 · 2d2bf99
1 parent 141c802
commit 2d2bf99
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 4 deletions.
diff --git a/.changeset/eleven-phones-reflect.md b/.changeset/eleven-phones-reflect.md
@@ -0,0 +1,7 @@
+---
+'skuba': patch
+---
+
+**template:** Enable retry of successful deployment steps
+
+This should be used with caution, but may be necessary if you need to rapidly roll back a broken deployment.
diff --git a/template/express-rest-api/.buildkite/pipeline.yml b/template/express-rest-api/.buildkite/pipeline.yml
@@ -4,6 +4,14 @@ configs:
       env:
         NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token
 
+  - &deploy
+    concurrency: 1
+    retry:
+      manual:
+        # Only use this if you need to roll back a deployment ASAP.
+        # Always follow up with a proper revert or fix in Git history.
+        permit_on_passed: true
+
   - &dev
     agents:
       queue: <%- devBuildkiteQueueName %>
@@ -41,8 +49,8 @@ steps:
     branches: '!master'
 
   - <<: *dev
+    <<: *deploy
     label: 🤞 Deploy Dev
-    concurrency: 1
     concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
     plugins:
       - seek-jobs/gantry#v1.2.9:
@@ -56,9 +64,9 @@ steps:
   - wait
 
   - <<: *prod
+    <<: *deploy
     label: 🚀 Deploy Prod
     branches: master
-    concurrency: 1
     concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
     plugins:
       - seek-jobs/gantry#v1.2.9:

diff --git a/template/koa-rest-api/.buildkite/pipeline.yml b/template/koa-rest-api/.buildkite/pipeline.yml
@@ -4,6 +4,14 @@ configs:
       env:
         NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token
 
+  - &deploy
+    concurrency: 1
+    retry:
+      manual:
+        # Only use this if you need to roll back a deployment ASAP.
+        # Always follow up with a proper revert or fix in Git history.
+        permit_on_passed: true
+
   - &dev
     agents:
       queue: <%- devBuildkiteQueueName %>
@@ -41,8 +49,8 @@ steps:
     branches: '!master'
 
   - <<: *dev
+    <<: *deploy
     label: 🤞 Deploy Dev
-    concurrency: 1
     concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
     plugins:
       - seek-jobs/gantry#v1.2.9:
@@ -56,9 +64,9 @@ steps:
   - wait
 
   - <<: *prod
+    <<: *deploy
     label: 🚀 Deploy Prod
     branches: master
-    concurrency: 1
     concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
     plugins:
       - seek-jobs/gantry#v1.2.9:

diff --git a/template/lambda-sqs-worker/.buildkite/pipeline.yml b/template/lambda-sqs-worker/.buildkite/pipeline.yml
@@ -25,6 +25,11 @@ configs:
       - docker-compose#v3.7.0:
           dependencies: false
           run: app
+    retry:
+      manual:
+        # Only use this if you need to roll back a deployment ASAP.
+        # Always follow up with a proper revert or fix in Git history.
+        permit_on_passed: true
 
   - &dev
     agents: