#yaml #circle-ci #orb #unpack #compatible #separate

bin+lib orb-unpack

Unpack a CircleCI orb.yml into separate files compatible with orb packing

3 releases

0.1.2 Oct 18, 2022
0.1.1 Jul 20, 2022
0.1.0 Jul 20, 2022

#904 in Configuration

ISC license

8KB
68 lines

CircleCI Orb Unpacking Tool

Crates.io License

This CLI tool is designed to facilitate the process of migrating a CircleCI Orb to the Orb Development Kit format, where components are stored in separate files rather than in one orb.yml file. By running this tool on a given orb.yml file, the specified destination directory will be populated with a file structure as as follows:

src
├── @orb.yml
├── commands
├── executors
└── jobs

This output is designed to be compatible with the circleci orb pack command such that running it on the destination directory will produce an equivalent orb file to the original source of the unpacking.

Installation

Ensure that you have cargo installed on your machine and run:

cargo install orb-unpack

Usage

orb-unpack ./orb.yml ./src

This will create a src/ directory in the current directory and unpack the orb's compoents into src/.

License

Licensed under ISC

Dependencies

~3.5MB
~70K SLoC