docs(sample): add orb example project (#179)

Author: KyleTryon

sample/03-orb-usage-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: /home/circleci/project/.circleci/src/dynamicConfig.yml
+workflows:
+  dynamic-workflow:
+    jobs:
+      - generate-config

sample/03-orb-usage-typescript/.circleci/src/executors/index.ts

@@ -0,0 +1,8 @@
+import * as CircleCI from "@circleci/circleci-config-sdk";
+
+const nodeExecutor = new CircleCI.executors.DockerExecutor(
+  `cimg/node:19.8.1`,
+  "small"
+);
+
+export { nodeExecutor }

sample/03-orb-usage-typescript/.circleci/src/index.ts

@@ -0,0 +1,23 @@
+import * as CircleCI from '@circleci/circleci-config-sdk';
+import { SlackOrb } from './orbs';
+import { nodeExecutor } from './executors';
+
+const myConfig = new CircleCI.Config();
+const myWorkflow = new CircleCI.Workflow('my-workflow');
+myConfig.importOrb(SlackOrb);
+
+const myJob = new CircleCI.Job('example-job', nodeExecutor, [
+  new CircleCI.commands.Checkout(),
+  new CircleCI.commands.Run({ command: 'npm install' }),
+  new CircleCI.commands.Run({ command: 'npm test' }),
+  new CircleCI.reusable.ReusedCommand(SlackOrb.commands['notify'], {
+    event: "pass",
+    template: "basic_success_1",
+  } )
+]);
+
+myConfig.addJob(myJob);
+myWorkflow.addJob(myJob);
+
+myConfig.addWorkflow(myWorkflow);
+myConfig.writeFile('dynamicConfig.yml')

sample/03-orb-usage-typescript/.circleci/src/orbs/index.ts

@@ -0,0 +1,38 @@
+import * as CircleCI from "@circleci/circleci-config-sdk";
+// Though reusable config in CircleCI can be replaced with JavaScript in many cases, often we want to take advantage of
+// the existing Orbs that are already provided by the community and CircleCI team.
+
+// We will be using the Slack orb
+// https://circleci.com/developer/orbs/orb/circleci/slack
+
+// The Slack orb's included command and job happen to share the same parameters.
+const SlackParams = new CircleCI.parameters.CustomParametersList([
+  new CircleCI.parameters.CustomParameter("branch_pattern", "string"),
+  new CircleCI.parameters.CustomParameter("tag_pattern", "string"),
+  new CircleCI.parameters.CustomParameter("channel", "string"),
+  new CircleCI.parameters.CustomEnumParameter("event", ["fail", "pass", "always"]),
+  new CircleCI.parameters.CustomParameter("mentions", "string"),
+  new CircleCI.parameters.CustomParameter("custom", "string"),
+  new CircleCI.parameters.CustomParameter("template", "string"),
+])
+
+// The manifest gives us access to the components provided by the orb and their parameters in TypeScript, with proper type checking.
+const SlackOrbManifest: CircleCI.types.orb.OrbImportManifest = {
+  commands: {
+    notify: SlackParams,
+  },
+  jobs: {
+    "on-hold": SlackParams,
+  },
+  executors: {},
+};
+
+// Export the "imported" orb, which we can then use in our config.
+export const SlackOrb = new CircleCI.orb.OrbImport(
+  "slack", // The "alias" of the orb, used to reference it in the config
+  "circleci", // The namespace of the orb
+  "slack", // The name of the orb
+  "4.12", // The version of the orb
+  "An optional description of the orb",
+  SlackOrbManifest // The manifest gives us access to the commands and jobs provided by the orb in TypeScript
+);