Circle Orbs for Atlas

This repository contains CircleCI Orbs for working with Atlas.

To learn more about the recommended way to build workflows, read our guide on Modern CI/CD for Databases.

Orbs

Orb	Description
atlas-orb/setup	Setup the Atlas CLI and optionally login to Atlas Cloud
atlas-orb/migrate_push	Push migrations to Atlas Registry
atlas-orb/migrate_lint	Lint migrations (required atlas login )
atlas-orb/migrate_apply	Apply migrations to a database
atlas-orb/migrate_down	Revert migrations to a database
atlas-orb/migrate_test	Test migrations on a database
atlas-orb/schema_test	Test schema on a database
atlas-orb/schema_push	Push a schema to Atlas Registry
atlas-orb/schema_plan	Plan a declarative migration for a schema transition
atlas-orb/schema_plan_approve	Approve a declarative migration plan
atlas-orb/schema_apply	Apply a declarative migrations to a database

Examples

Check out this link for more information on how to use the 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 ariga/atlas-orb | 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.