https://github.com/a11ywatch/circleci-orb

The A11yWatch CircleCI orb
https://github.com/a11ywatch/circleci-orb

Last synced: 2 months ago
JSON representation

The A11yWatch CircleCI orb

• Host: GitHub
• URL: https://github.com/a11ywatch/circleci-orb
• Owner: a11ywatch
• License: mit
• Created: 2022-04-28T14:03:47.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-30T00:01:56.000Z (almost 3 years ago)
• Last Synced: 2025-01-01T09:41:46.306Z (4 months ago)
• Language: Shell
• Size: 11.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Orb Source

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.

## @orb.yml

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**

1. **version**

    Specify version 2.1 for orb-compatible configuration `version: 2.1`

2. **description**

    Give your orb a description. Shown within the CLI and orb registry

3. **display**

    Specify the `home_url` referencing documentation or product URL, and `source_url` linking to the orb's source repository.

4. **orbs**

    (optional) Some orbs may depend on other orbs. Import them here.

## See:

 - [Orb Author Intro](https://circleci.com/docs/2.0/orb-author-intro/#section=configuration)

 - [Reusable Configuration](https://circleci.com/docs/2.0/reusing-config)