Orb Template

A project template for Orbs.

This repository is designed to be automatically ingested and modified by the CircleCI CLI's orb init command.

Edit this area to include a custom title and description.

---

Resources

CircleCI Orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described.

CircleCI Orb Docs - Docs for using, creating, and publishing CircleCI Orbs.

How to Contribute

We welcome issues to and pull requests against this repository!

How to Publish An Update

1. Merge pull requests with desired changes to the main branch.
   • For the best experience, squash-and-merge and use Conventional Commit Messages.
2. Find the current version of the orb.
   • You can run circleci orb info <namespace>/<orb-name> | grep "Latest" to see the current version.
3. Create a new Release on GitHub.
   • Click "Choose a tag" and create a new semantically versioned tag. (ex: v1.0.0)
     • We will have an opportunity to change this before we publish if needed after the next step.
4. Click "+ Auto-generate release notes".
   • This will create a summary of all of the merged pull requests since the previous release.
   • If you have used Conventional Commit Messages it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published.
5. Now ensure the version tag selected is semantically accurate based on the changes included.
6. Click "Publish Release".
   • This will push a new tag and trigger your publishing pipeline on CircleCI.

Development Orbs

Prerequisites:

• An initial sevmer deployment must be performed in order for Development orbs to be published and seen in the Orb Registry.

A Development orb can be created to help with rapid development or testing. To create a Development orb, change the orb-tools/publish job in test-deploy.yml to be the following:

- orb-tools/publish:
    orb_name: <namespace>/<orb-name>
    vcs_type: << pipeline.project.type >>
    pub_type: dev
    # Ensure this job requires all test jobs and the pack job.
    requires:
      - orb-tools/pack
      - command-test
    context: <publishing-context>
    filters: *filters

The job output will contain a link to the Development orb Registry page. The parameters enable_pr_comment and github_token can be set to add the relevant publishing information onto a pull request. Please refer to the orb-tools/publish documentation for more information and options.