You can deploy to Convox as part of a CircleCI workflow using the Convox Orb
Sign Up for CircleCI
If you don’t have an account already, sign up for CircleCI.
Configure Your CircleCI Project to Build With Convox
If you don’t already have a project setup in CircleCI you will need to add one
Once you have your project added, login to the Convox console and click on the settings tab in the left side navigation bar.
From here generate a deploy key and copy it to your local clipboard.
In CircleCI, add an environment variable with the name
CONVOX_PASSWORD and paste your deploy key as the value and if you self-host a console (enterprise customers) you need to specify the
CONVOX_HOST with your console URL.
Build a CircleCI config.yml Using the Convox Orb
Note: You must specify
version: 2.1 in your config.yml in order to use Orbs
The Convox Orb contains a single
deploy command and matching job for deploying your app to Convox using CircleCI.
The job is self contained. If you would prefer to use the command you must run the
checkout command before using
deploy Job/Command accepts the following parameters:
||The Rack to deploy to||Yes|
||The App to deploy||No||Project Repository Name|
||Your console hostname||No||console.convox.com|
The simplest version of a config.yml would look like:
version: 2.1 orbs: convox: firstname.lastname@example.org workflows: deploy: jobs: - convox/deploy: rack: production app: example
This will build and deploy your app in a single step
If you would prefer to use the Convox Orb commands directly you need to run the
checkout command before deploy:
version: 2.1 orbs: convox: email@example.com workflows: deploy: jobs: - deploy jobs: deploy: executor: convox/cli steps: - checkout - run: make test - convox/deploy: rack: production app: example
Check our orb page to see if we have a new orb version.