docs: create matrix deploy sample (#178)

Author: KyleTryon

sample/02-matrix-jobs-typescript/.circleci/config.yml

@@ -0,0 +1,21 @@
+version: 2.1
+orbs:
+  continuation: circleci/[email protected]
+  node: circleci/[email protected]
+setup: true
+jobs:
+  generate-config:
+    executor: node/default
+    steps:
+      - checkout
+      - node/install-packages:
+          app-dir: .circleci/src
+      - run:
+          name: Generate config
+          command: cd .circleci/src && npm run generate
+      - continuation/continue:
+          configuration_path: .circleci/src/dynamicConfig.yml
+workflows:
+  dynamic-workflow:
+    jobs:
+      - generate-config

sample/02-matrix-jobs-typescript/src/executors/index.ts

@@ -0,0 +1,9 @@
+import * as CircleCI from "@circleci/circleci-config-sdk";
+
+// A function that returns an executor for a given version of Node. Optionally configure the resource class.
+const nodeExecutor = (
+  version: string,
+  resourceSize: CircleCI.types.executors.executor.AnyResourceClassBase = "small",
+) => new CircleCI.executors.DockerExecutor(`cimg/node:${version}`, resourceSize);
+
+export { nodeExecutor }

sample/02-matrix-jobs-typescript/src/index.ts

@@ -0,0 +1,31 @@
+import * as CircleCI from '@circleci/circleci-config-sdk';
+import { testJob, deployJob } from './jobs';
+import { isDeployable } from './utils';
+
+// Create a new config and workflow
+const myConfig = new CircleCI.Config();
+const myWorkflow = new CircleCI.Workflow('my-workflow');
+
+// Support the three latest versions of Node
+const nodeVersions = ["16.19", "18.13", "19.7"];
+
+// Create a test job for each version of Node and add it to the config and workflow
+const testJobs = nodeVersions.map((version) => testJob(version));
+testJobs.forEach((job) => {
+  myConfig.addJob(job);
+  myWorkflow.addJob(job)
+});
+
+// If it's a deployable day, add the deploy job to the config and workflow
+if (isDeployable()) {
+  myConfig.addJob(deployJob);
+  myWorkflow.addJob(deployJob, {
+    requires: testJobs.map((job) => job.name)
+  });
+}
+
+// Add the workflow to the config
+myConfig.addWorkflow(myWorkflow);
+
+// Write the config to a file
+myConfig.writeFile('dynamicConfig.yml')

sample/02-matrix-jobs-typescript/src/jobs/index.ts

@@ -0,0 +1,24 @@
+import * as CircleCI from "@circleci/circleci-config-sdk";
+import { nodeExecutor } from "../executors";
+
+// A function that returns a test job for a given version of Node with a unique name
+const testJob = (version: string) =>
+  new CircleCI.Job(`test-${version.replace('.', '-')}`, nodeExecutor(version), [
+    new CircleCI.commands.Checkout(),
+    new CircleCI.commands.Run({
+      command: 'npm install && npm run test',
+    }),
+  ]);
+
+const deployJob = new CircleCI.Job(
+  "deploy",
+  nodeExecutor("18"),
+  [
+    new CircleCI.commands.Checkout(),
+    new CircleCI.commands.Run({
+      command: "npm install && npm run deploy"
+    })
+  ]
+)
+
+export { testJob, deployJob }