Skip to content

A lightweight utility to import orbs for use with the CircleCI Config SDK

License

Notifications You must be signed in to change notification settings

voiceflow/circleci-config-sdk-orb-import

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Orb Import for CircleCI Config SDK

NPM Version License

This package allows you to import and use external orbs with the CircleCI Config SDK.

Installation

Using npm:

   npm install @voiceflow/circleci-config-sdk-orb-import 

Using yarn:

    yarn add @voiceflow/circleci-config-sdk-orb-import 

Usage

This package provides a single function, importOrb, to fetch the manifest for an external orb and return them as an OrbImport compatible with the CircleCI Config SDK.

import * as CircleCI from "@circleci/circleci-config-sdk";
import { importOrb } from "circleci-config-sdk-orb-import";

// Instantiate a new Config
const config = new CircleCI.Config();

// Use the importOrb function to fetch a given external orb
// This is equivalent to putting `node: circleci/[email protected]` in the `.circleci/config.yml` file
const node = await importOrb({
  alias: "node",
  namespace: "circleci",
  orb: "node",
  version: "5.0.3",
});

// Add the imported orb to the generated config
config.importOrb(node);

// Use an executor from the orb in your jobs
const exampleExecutor = new CircleCI.reusable.ReusedExecutor(
  node.executors["default"],
  {
    tag: "16",
  }
);

const exampleJob = new CircleCI.Job("install-node", exampleExecutor, [
  new CircleCI.commands.Checkout(),
  // Use a command from the orb in your jobs
  new CircleCI.reusable.ReusedCommand(node.commands["install-packages"], {
    "check-cache": "always",
    "pkg-manager": "yarn-berry",
  }),
]);
config.addJob(exampleJob);

const exampleWorkflow = new CircleCI.Workflow("example", [
  exampleJob,
  // Use a job from the orb in your workflows
  new CircleCI.workflow.WorkflowJob(node.jobs["run"], {
    "yarn-run": "build",
  }),
]);
config.addWorkflow(exampleWorkflow);

The above config generates the following YAML config:

version: 2.1
setup: false
jobs:
  install-node:
    executor:
      name: node/default
      tag: "16"
    steps:
      - checkout
      - node/install-packages:
          check-cache: always
          pkg-manager: yarn-berry
workflows:
  example:
    jobs:
      - install-node
      - node/run:
          yarn-run: build
orbs:
  node: circleci/[email protected]

Compatibility

This version has been tested with version 0.10.1 of the CircleCI Config SDK. Compatibility with other versions cannot be guaranteed.

License

Licensed under ISC

About

A lightweight utility to import orbs for use with the CircleCI Config SDK

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published