fix: use nullish coalescing instead of zod defaults for circleci hook…

… options with defaults the `.partial()` on the hook option objects is overriding the `.default()` on their properties. short of splitting the schema into an incoming options schema that's meant to be merged from multiple sources, and an outgoing schema for the final hook options, this is the most straightforward way of doing this.
Financial-Times · Jan 16, 2025 · 02ca200 · 02ca200
1 parent 77b2c2c
commit 02ca200
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 17 deletions.
diff --git a/lib/schemas/src/hooks/circleci.ts b/lib/schemas/src/hooks/circleci.ts
@@ -20,22 +20,16 @@ export const CircleCiJob = z
     command: z.string(),
     workspace: z
       .object({
-        persist: z.boolean().default(true),
-        attach: z.boolean().default(true)
+        persist: z.boolean().optional(),
+        attach: z.boolean().optional()
       })
-      .default({
-        persist: true,
-        attach: true
-      }),
+      .optional(),
     steps: z
       .object({
-        pre: z.array(CircleCiStep).default([]),
-        post: z.array(CircleCiStep).default([])
+        pre: z.array(CircleCiStep).optional(),
+        post: z.array(CircleCiStep).optional()
       })
-      .default({
-        pre: [],
-        post: []
-      }),
+      .optional(),
     custom: CircleCiCustom.optional()
   })
   .partial()
@@ -47,7 +41,7 @@ export const CircleCiWorkflowJob = z
     name: z.string(),
     requires: z.array(z.string()),
     splitIntoMatrix: z.boolean().optional(),
-    runOnRelease: z.boolean().default(true),
+    runOnRelease: z.boolean().optional(),
     custom: CircleCiCustom.optional()
   })
   .partial()

diff --git a/plugins/circleci-deploy/test/__snapshots__/circleci-deploy.test.ts.snap b/plugins/circleci-deploy/test/__snapshots__/circleci-deploy.test.ts.snap
@@ -41,10 +41,16 @@ workflows:
           executor: node
           requires:
             - tool-kit/setup
+          filters:
+            tags:
+              only: /^v\\d+\\.\\d+\\.\\d+(-.+)?/
       - tool-kit/test:
           executor: node
           requires:
             - tool-kit/build
+          filters:
+            tags:
+              only: /^v\\d+\\.\\d+\\.\\d+(-.+)?/
       - tool-kit/deploy-review:
           executor: node
           requires:

diff --git a/plugins/circleci-npm/test/__snapshots__/circleci-npm.test.ts.snap b/plugins/circleci-npm/test/__snapshots__/circleci-npm.test.ts.snap
@@ -41,18 +41,26 @@ workflows:
           executor: node
           requires:
             - tool-kit/setup
+          filters:
+            tags:
+              only: /^v\\d+\\.\\d+\\.\\d+(-.+)?/
       - tool-kit/test:
           executor: node
           requires:
             - tool-kit/build
+          filters:
+            tags:
+              only: /^v\\d+\\.\\d+\\.\\d+(-.+)?/
       - tool-kit/publish-tag:
           executor: node
           requires:
             - tool-kit/test
-          context: npm-publish-token
           filters:
+            tags:
+              only: /^v\\d+\\.\\d+\\.\\d+(-.+)?/
             branches:
               ignore: /.*/
+          context: npm-publish-token
   nightly:
     when:
       and:

diff --git a/plugins/circleci/src/circleci-config.ts b/plugins/circleci/src/circleci-config.ts
@@ -396,7 +396,7 @@ const generateWorkflowJobs = (
             return `${requiredOrb}-${splitIntoMatrix ? '<< matrix.executor >>' : 'node'}`
           })
         },
-        workflow.runOnRelease && job.runOnRelease ? tagFilter(tagFilterRegex) : {},
+        workflow.runOnRelease && (job.runOnRelease ?? true) ? tagFilter(tagFilterRegex) : {},
         job.custom
       )
     }
@@ -418,7 +418,7 @@ const attachWorkspaceStep = {
 
 const generateJob = (job: CircleCiJob): JobConfig => ({
   steps: [
-    ...(job.workspace?.attach ? [attachWorkspaceStep] : []),
+    ...(job.workspace?.attach ?? true ? [attachWorkspaceStep] : []),
     ...(job.steps?.pre ?? []),
     {
       run: {
@@ -427,7 +427,7 @@ const generateJob = (job: CircleCiJob): JobConfig => ({
       }
     },
     ...(job.steps?.post ?? []),
-    ...(job.workspace?.persist ? [persistWorkspaceStep] : [])
+    ...(job.workspace?.persist ?? true ? [persistWorkspaceStep] : [])
   ],
   ...job.custom
 })

diff --git a/plugins/circleci/test/__snapshots__/circleci-config.test.ts.snap b/plugins/circleci/test/__snapshots__/circleci-config.test.ts.snap
@@ -41,10 +41,16 @@ workflows:
           executor: node
           requires:
             - tool-kit/setup
+          filters:
+            tags:
+              only: /^v\\d+\\.\\d+\\.\\d+(-.+)?/
       - tool-kit/test:
           executor: node
           requires:
             - tool-kit/build
+          filters:
+            tags:
+              only: /^v\\d+\\.\\d+\\.\\d+(-.+)?/
   nightly:
     when:
       and:

diff --git a/plugins/circleci/test/circleci-config.test.ts b/plugins/circleci/test/circleci-config.test.ts
@@ -157,12 +157,25 @@ describe('CircleCI config hook', () => {
           "jobs": {
             "test-job": {
               "steps": [
+                {
+                  "attach-workspace": {
+                    "at": ".",
+                  },
+                },
                 {
                   "run": {
                     "command": "npx dotcom-tool-kit test:local",
                     "name": "test-job",
                   },
                 },
+                {
+                  "persist_to_workspace": {
+                    "paths": [
+                      ".",
+                    ],
+                    "root": ".",
+                  },
+                },
               ],
             },
           },
@@ -217,12 +230,25 @@ describe('CircleCI config hook', () => {
           "jobs": {
             "test-job": {
               "steps": [
+                {
+                  "attach-workspace": {
+                    "at": ".",
+                  },
+                },
                 {
                   "run": {
                     "command": "npx dotcom-tool-kit test:local",
                     "name": "test-job",
                   },
                 },
+                {
+                  "persist_to_workspace": {
+                    "paths": [
+                      ".",
+                    ],
+                    "root": ".",
+                  },
+                },
               ],
             },
           },