Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 57 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,64 @@

CircleCI Orb for deploying to Convox.

## Usage
# Usage

https://docs.convox.com/external-services/circleci
## Sign Up for CircleCI
If you don’t have an account already, [sign up for CircleCI](https://circleci.com/signup/).

## Configure Your CircleCI Project to Build With Convox
Setup your project in CircleCI by clicking [here](https://circleci.com/docs/2.0/gh-bb-integration/#section=projects).

After adding your project, login to the Convox console and click on the settings tab in navigation bar which is on the left side.

Generate a [deploy key](https://docs.convox.com/console/deploy-keys) and copy it to your local clipboard.

Now in CircleCI, [add an environment variable](https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-project) with the name CONVOX_DEPLOY_KEY and paste your deploy key as the value.

## 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.

The deploy Job/Command accepts the following parameters:
<img src="/assets/image.JPG" alt="Parameters"/>

## Examples
config.yml
----------------------------------------------------
version: 2.1
orbs:
convox: convox/[email protected]
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: convox/[email protected]
workflows:
deploy:
jobs:
- deploy
jobs:
deploy:
executor: convox/cli
steps:
- checkout
- run: make test
- convox/deploy:
rack: production
app: example

For Further information: https://docs.convox.com/external-services/circleci

## See Also

Expand Down
Binary file added assets/image.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.