Rackspace Cloud Files Deployment

This page documents deployments using dpl v1 which is currently the legacy version. The dpl v2 is released, and we recommend useig it. Please see our blog post for details. dpl v2 documentation can be found here.

Deploy On Tags
Deploy to one Folder
Release Branch

Travis CI can automatically upload your build to Rackspace Cloud Files after a successful build.

For a minimal configuration, all you need to do is add the following to your .travis.yml:

deploy:
  provider: cloudfiles
  username: "RACKSPACE USERNAME"
  api_key: "RACKSPACE API KEY"
  region: "CLOUDFILE REGION"
  container: "CLOUDFILES CONTAINER NAME"

This example is almost certainly not ideal, as you probably want to upload your built binaries and documentation. Set skip_cleanup to true to prevent Travis CI from deleting your build artifacts.

deploy:
  provider: cloudfiles
  username: "RACKSPACE USERNAME"
  api_key: "RACKSPACE API KEY"
  region: "CLOUDFILE REGION"
  container: "CLOUDFILES CONTAINER NAME"
  skip_cleanup: true

It is recommended encrypt that you encrypt your Rackspace api key. Assuming you have the Travis CI command line client installed, you can do it like this:

travis encrypt --add deploy.api-key

You will be prompted to enter your api key on the command line.

You can also have the travis tool set up everything for you:

travis setup cloudfiles

Keep in mind that the above command has to run in your project directory, so it can modify the .travis.yml for you.

Deploy On Tags #

Often, you want to deploy only when you release a new version of your code.

You can tell Travis CI only to deploy on tags, like this:

deploy:
  provider: cloudfiles
  username: "RACKSPACE USERNAME"
  api_key: "RACKSPACE API KEY"
  region: "CLOUDFILE REGION"
  container: "CLOUDFILES CONTAINER NAME"
  skip_cleanup: true
  on:
    tags: true

Deploy to one Folder #

Often, you don’t want to upload your entire project to Cloud Files. You can tell Travis CI to only upload a single folder to Cloud Files. This example uploads the build directory of your project to Cloud Files:

before_deploy: "cd build"
deploy:
  provider: cloudfiles
  username: "RACKSPACE USERNAME"
  api_key: "RACKSPACE API KEY"
  region: "CLOUDFILE REGION"
  container: "CLOUDFILES CONTAINER NAME"
  skip_cleanup: true

Deploy to Multiple Containers #

If you want to upload to multiple containers, you can do this:

deploy:
  - provider: cloudfiles
    username: "RACKSPACE USERNAME"
    api_key: "RACKSPACE API KEY"
    region: "CLOUDFILE REGION"
    container: "CLOUDFILES CONTAINER NAME"
    skip_cleanup: true
  - provider: cloudfiles
    username: "RACKSPACE USERNAME"
    api_key: "RACKSPACE API KEY"
    region: "CLOUDFILE REGION"
    container: "CLOUDFILES CONTAINER NAME"
    skip_cleanup: true

Release Branch #

You can explicitly specify the branch to release from with the on option:

deploy:
  provider: cloudfiles
  username: "RACKSPACE USERNAME"
  api_key: "RACKSPACE API KEY"
  region: "CLOUDFILE REGION"
  container: "CLOUDFILES CONTAINER NAME"
  skip_cleanup: true
  on:
    branch: production

Alternatively, you can also configure Travis CI to release from all branches:

deploy:
  provider: cloudfiles
  username: "RACKSPACE USERNAME"
  api_key: "RACKSPACE API KEY"
  region: "CLOUDFILE REGION"
  container: "CLOUDFILES CONTAINER NAME"
  skip_cleanup: true
  on:
    all_branches: true

Builds triggered from Pull Requests will never trigger a release.

Conditional Releases #

You can deploy only when certain conditions are met. See Conditional Releases with on:.

Run Commands Before or After Release #

Sometimes, you want to run commands before or after releasing a gem. You can use the before_deploy and after_deploy stages for this. These will only be triggered if Travis CI is actually pushing a release.

before_deploy: "echo 'ready?'"
deploy:
  ..
after_deploy:
  - ./after_deploy_1.sh
  - ./after_deploy_2.sh