Orbs are shipped as individual orb.yml files, however, to make development easier, it is possible to author an orb in unpacked form, which can be packed with the CircleCI CLI and published.
The default .circleci/config.yml file contains the configuration code needed to automatically pack, test, and deploy and changes made to the contents of the orb source in this directory.
This is the entry point for our orb "tree", which becomes our orb.yml file later.
Within the @orb.yml we generally specify 4 configuration keys
Keys
- version
Specify version 2.1 for orb-compatible configuration
version: 2.1 - description Give your orb a description. Shown within the CLI and orb registry
- display
Specify the
home_urlreferencing documentation or product URL, andsource_urllinking to the orb's source repository. - orbs (optional) Some orbs may depend on other orbs. Import them here.