Feature Branch Deploys

cdk/kraken/src/deploy.ts

@@ -16,6 +16,12 @@ export interface DeployJobProps {
    * @default master
    */
   defaultBranch?: string;
+
+  /**
+   * Deploy for a specific feature branch.
+   * @default false
+   */
+  isFeatureDeploy?: boolean;
 }
 
 /**
@@ -37,27 +43,46 @@ export class DeployJob extends CheckoutJob {
     const fullConfig: Required<DeployJobProps> = {
       deployTag: "${{ github.sha }}",
       defaultBranch: "master",
+      isFeatureDeploy: false,
       ...config,
     };
 
     super(scope, "deploy", {
       runsOn: "ubuntu-latest",
-      if: `github.ref == 'refs/heads/${fullConfig.defaultBranch}'`,
+      if: fullConfig.isFeatureDeploy
+        ? `github.event_name == 'pull_request'`
+        : `github.ref == 'refs/heads/${fullConfig.defaultBranch}'`,
       steps: [
         {
           id: "synth",
           name: "Synth cdk8s manifests",
           run: dedent`cd k8s
           yarn install --frozen-lockfile
+          ${
+            fullConfig.isFeatureDeploy
+              ? dedent`
+
+          # Feature Branch deployment set-up
+          export IS_FEATURE_BRANCH=true;
+          export RELEASE_NAME=\${REPOSITORY#*/}-pr-$PR_NUMBER;
+
+          `
+              : dedent`
 
-          # get repo name (by removing owner/organization)
+          # Get repo name (by removing owner/organization)
           export RELEASE_NAME=\${REPOSITORY#*/}
 
+              `
+          }
           # Export RELEASE_NAME as an output
           echo "::set-output name=RELEASE_NAME::$RELEASE_NAME"
 
           yarn build`,
           env: {
+            ...(fullConfig.isFeatureDeploy && {
+              PR_NUMBER: "${{ github.event.pull_request.number }}",
+              GIT_REF: "${{ github.ref }}",
+            }),
             GIT_SHA: fullConfig.deployTag,
             REPOSITORY: "${{ github.repository }}",
             AWS_ACCOUNT_ID: "${{ secrets.AWS_ACCOUNT_ID }}",
@@ -67,7 +92,7 @@ export class DeployJob extends CheckoutJob {
           name: "Deploy",
           run: dedent`aws eks --region us-east-1 update-kubeconfig --name production --role-arn arn:aws:iam::\${AWS_ACCOUNT_ID}:role/kubectl
 
-          # get repo name from synth step
+          # Get repo name from synth step
           RELEASE_NAME=\${{ steps.synth.outputs.RELEASE_NAME }}
 
           # Deploy

cdk/kraken/src/labs-application.ts

@@ -8,6 +8,7 @@ import {
   IntegrationTestsJob,
   IntegrationTestsJobProps,
 } from "./integration-tests";
+import { NukeJob } from "./nuke";
 import { ReactCheckJobProps } from "./react";
 import { ReactProject } from "./react-project";
 
@@ -207,5 +208,42 @@ export class LabsApplicationStack extends Stack {
       ...fullConfig.deployOverrides,
       needs: deployNeeds,
     });
+
+    // Feature Branch Deploy
+    const featureBranchDeployWorkflow = new Workflow(
+      this,
+      "feature-branch-deploy",
+      {
+        name: "Feature Branch Deploy",
+        on: { pullRequest: { types: ["opened"] } },
+        ...overrides,
+      }
+    );
+
+    new DeployJob(
+      featureBranchDeployWorkflow,
+      {
+        ...fullConfig.deployProps,
+        isFeatureDeploy: true,
+      },
+      {
+        ...fullConfig.deployOverrides,
+      }
+    );
+
+    // Feature Branch Nuke
+    const featureBranchNukeWorkflow = new Workflow(
+      this,
+      "feature-branch-nuke",
+      {
+        name: "Feature Branch Nuke",
+        on: { pullRequest: { types: ["closed"] } },
+        ...overrides,
+      }
+    );
+
+    new NukeJob(featureBranchNukeWorkflow, fullConfig.deployProps, {
+      ...fullConfig.deployOverrides,
+    });
   }
 }

cdk/kraken/src/nuke.ts

@@ -0,0 +1,82 @@
+import { CheckoutJob, Workflow, JobProps } from "cdkactions";
+import dedent from "ts-dedent";
+
+/**
+ * Optional props to configure the nuke job.
+ */
+export interface NukeJobProps {
+  /**
+   * Deploy tag to set in kittyhawk.
+   * @default current git sha
+   */
+  deployTag?: string;
+}
+
+/**
+ * A job to undeploy/nuke a product.
+ * When we nuke, it should ALWAYS be for feature branch deployment, not production.
+ */
+export class NukeJob extends CheckoutJob {
+  /**
+   *
+   * @param scope cdkactions Workflow instance
+   * @param config Optional configuration for the deploy job.
+   * @param overrides Optional overrides for the job.
+   */
+  public constructor(
+    scope: Workflow,
+    config?: NukeJobProps,
+    overrides?: Partial<JobProps>
+  ) {
+    // Nuke config
+    const fullConfig: Required<NukeJobProps> = {
+      deployTag: "${{ github.sha }}",
+      ...config,
+    };
+
+    super(scope, "nuke", {
+      runsOn: "ubuntu-latest",
+      steps: [
+        {
+          id: "synth",
+          name: "Synth cdk8s manifests",
+          run: dedent`cd k8s
+          yarn install --frozen-lockfile
+
+          # Feature Branch nuke set-up
+          export IS_FEATURE_BRANCH=true;
+          export RELEASE_NAME=\${REPOSITORY#*/}-pr-$PR_NUMBER;
+
+          # Export RELEASE_NAME as an output
+          echo "::set-output name=RELEASE_NAME::$RELEASE_NAME"
+
+          yarn build`,
+          env: {
+            PR_NUMBER: "${{ github.event.pull_request.number }}",
+            GIT_REF: "${{ github.ref }}",
+            GIT_SHA: fullConfig.deployTag,
+            REPOSITORY: "${{ github.repository }}",
+            AWS_ACCOUNT_ID: "${{ secrets.AWS_ACCOUNT_ID }}",
+          },
+        },
+        {
+          name: "Nuke",
+          run: dedent`aws eks --region us-east-1 update-kubeconfig --name production --role-arn arn:aws:iam::\${AWS_ACCOUNT_ID}:role/kubectl
+
+          # Get repo name from synth step
+          RELEASE_NAME=\${{ steps.synth.outputs.RELEASE_NAME }}
+
+          # Delete all non-certificate resources
+          kubectl delete -f k8s/dist/ -l app.kubernetes.io/part-of=$RELEASE_NAME
+          `,
+          env: {
+            AWS_ACCOUNT_ID: "${{ secrets.AWS_ACCOUNT_ID }}",
+            AWS_ACCESS_KEY_ID: "${{ secrets.GH_AWS_ACCESS_KEY_ID }}",
+            AWS_SECRET_ACCESS_KEY: "${{ secrets.GH_AWS_SECRET_ACCESS_KEY }}",
+          },
+        },
+      ],
+      ...overrides,
+    });
+  }
+}