feat(circleci)!: add a pr-close workflow

BREAKING CHANGE: this workflow requires a repo to be using the Github
Apps integration since it references the `pipeline.event` values,
which will fail CircleCI config validation if using the OAuth integration

Author: apaleslimghost

core/cli/test/__snapshots__/config.test.ts.snap

@@ -15,6 +15,13 @@ options:
             command: 'test:staging'
           - name: deploy-production
             command: 'deploy:production'
+          - name: teardown-review
+            command: 'teardown:review'
+            workspace:
+              persist: false
+            custom:
+              environment:
+                CIRCLE_BRANCH: << pipeline.event.github.pull_request.head.ref >>
         workflows:
           - name: 'tool-kit'
             jobs:
@@ -85,6 +92,13 @@ options:
                   !toolkit/if-defined '@dotcom-tool-kit/serverless.awsAccountId':
                     aws-account-id: !toolkit/option '@dotcom-tool-kit/serverless.awsAccountId'
                     system-code: !toolkit/option '@dotcom-tool-kit/serverless.systemCode'
+          - name: 'pr-close'
+            jobs:
+              - name: 'teardown-review'
+                requires:
+                  - 'setup'
+                splitIntoMatrix: false
+                runOnRelease: false
         !toolkit/if-defined '@dotcom-tool-kit/circleci.cypressImage':
           executors:
             - name: cypress

plugins/circleci-deploy/.toolkitrc.yml

@@ -16,6 +16,15 @@ jobs:
       - checkout
       - tool-kit/persist-workspace:
           path: .
+  teardown-review:
+    executor: node
+    steps:
+      - tool-kit/attach-workspace
+      - run:
+          name: teardown-review
+          command: npx dotcom-tool-kit teardown:review
+    environment:
+      CIRCLE_BRANCH: << pipeline.event.github.pull_request.head.ref >>
 workflows:
   tool-kit:
     when:
@@ -116,5 +125,21 @@ workflows:
           filters:
             branches:
               ignore: main
+  pr-close:
+    jobs:
+      - checkout:
+          requires: []
+      - tool-kit/setup:
+          executor: node
+          requires:
+            - checkout
+      - teardown-review:
+          requires:
+            - tool-kit/setup
+    when: >
+      pipeline.trigger_source != "scheduled_pipeline" and
+
+      (pipeline.event.name == "pull_request" and pipeline.event.action ==
+      "closed")
 "
 `;

plugins/circleci-deploy/test/__snapshots__/circleci-deploy.test.ts.snap

@@ -10,7 +10,7 @@ const logger = winston as unknown as Logger
 describe('circleci-deploy', () => {
   describe('config integration test', () => {
     it('should generate a .circleci/config.yml with the base config from circleci-deploy/.toolkitrc.yml', async () => {
-      const config = await loadConfig(logger, { root: path.resolve(__dirname, '..') })
+      const config = await loadConfig(logger, { root: path.resolve(__dirname, 'files', 'configs', 'base') })
       const hookInstallationsPromise = loadHookInstallations(logger, config).then((validated) =>
         validated.unwrap('hooks were invalid')
       )

plugins/circleci-deploy/test/circleci-deploy.test.ts

@@ -0,0 +1,2 @@
+plugins:
+  - @dotcom-tool-kit/circleci-deploy

plugins/circleci-deploy/test/files/configs/base/.toolkitrc.yml

@@ -82,5 +82,18 @@ workflows:
           executor: node
           requires:
             - tool-kit/build
+  pr-close:
+    jobs:
+      - checkout:
+          requires: []
+      - tool-kit/setup:
+          executor: node
+          requires:
+            - checkout
+    when: >
+      pipeline.trigger_source != "scheduled_pipeline" and
+
+      (pipeline.event.name == "pull_request" and pipeline.event.action ==
+      "closed")
 "
 `;

plugins/circleci-npm/test/__snapshots__/circleci-npm.test.ts.snap

@@ -32,6 +32,17 @@ options:
               - name: test
                 requires:
                   - 'build'
+          - name: 'pr-close'
+            custom:
+              when: |
+                pipeline.trigger_source != "scheduled_pipeline" and
+                (pipeline.event.name == "pull_request" and pipeline.event.action == "closed")
+            jobs:
+              - name: 'checkout'
+              - name: 'setup'
+                requires:
+                  - 'checkout'
+
 
 init:
   - './lib/init-env-vars'

plugins/circleci/.toolkitrc.yml

@@ -72,5 +72,18 @@ workflows:
           executor: node
           requires:
             - tool-kit/build
+  pr-close:
+    jobs:
+      - checkout:
+          requires: []
+      - tool-kit/setup:
+          executor: node
+          requires:
+            - checkout
+    when: >
+      pipeline.trigger_source != "scheduled_pipeline" and
+
+      (pipeline.event.name == "pull_request" and pipeline.event.action ==
+      "closed")
 "
 `;

plugins/circleci/test/__snapshots__/circleci-config.test.ts.snap

@@ -622,7 +622,7 @@ describe('CircleCI config hook', () => {
     it('should generate a .circleci/config.yml with the base config from circleci/.toolkitrc.yml', async () => {
       // uses a fixture toolkitrc that loads the circleci plugin instead of the circleci toolkitrc
       // because option parsing doesn't work if loading the circleci toolkitrc directly
-      const config = await loadConfig(logger, { root: path.resolve(__dirname, 'files') })
+      const config = await loadConfig(logger, { root: path.resolve(__dirname, 'files', 'configs', 'base') })
 
       const hookInstallationsPromise = loadHookInstallations(logger, config).then((validated) =>
         validated.unwrap('hooks were invalid')