DreamOps Orb

CircleCI orb for installing and configuring the dream-ops CLI in your CircleCI jobs.

How to Contribute

We welcome issues to and pull requests against this repository!

How to Publish a Development Orb

As outlined in CircleCI Orb Concepts, you can publish devlopment orbs using the CLI. The version string must start with dev: followed by any string. A good convention is to use the feature branch in the name (eg. apaxsoftware/dream-ops@dev:feature-branch).

To validate your local orb:

circleci orb pack src | circleci orb validate -

And to publish a public orb that's unlisted in the registry and expires in 90 days:

circleci orb pack src | circleci orb publish - apaxsoftware/dream-ops@dev:feature-branch

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 apaxsoftware/dream-ops | 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.