dpl 1.5.2.travis.184.2 → 1.5.2.travis.187.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjZiN2QzOGEzMjNhMWI2ODdjODA3MjU2NTU5MzYyYjBiOWUyODYzNA==
+    OTg1ZmZjYWE4N2RmYWE4YzI4NjE5MGNiZWQyZjQyNTllY2U1NzAzNA==
   data.tar.gz: !binary |-
-    ZTdkZTA4NDU1YWVjODQ1MDQ5ZTE3Y2Q5NDEyMDI0Njg5YzVhODIyMA==
+    YTkyOWM0ZGJkZjlhYWZhOWJhMzJiYTg0MjU3NDE4ODMyNDcwYzU2Yw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZGMxMTg5ODk2YTEyMTU3NWE0MWRmZmVlNmI5NWUyNzY4NjhjNmVjYTNiMWE1
-    OGZmNzMzNThlMjBhNTFiNjQ4YzgzNWJmZWRjZTZjYjM5YjQ1NzVlZTZiNzBk
-    MTUxZjg0OWI0ZmFiOTA0MTRjYTUzOGQ3MjZmMjNmMGVhODc1MmE=
+    MWQ4ZTc0OGNhNjFkM2U0NDcxNjYyMWRhYWQzOGRhNTg0MDIxY2FiZTcwNmQ0
+    MTdjOTA3ZGFmNmJlZDkzNzZlODFiMmRmMmJhZTZhZWFkZjJmZjVhMDNiZjhi
+    YmViNjEzZWRmNGM1YjI0NDcxMmFiYjliNDA3MTk5ZmUwYzlhMmE=
   data.tar.gz: !binary |-
-    ZjFhYWRjZWYxNDMxNGQ0ZTQzODNkZjAzODU1NWViZTU5OWIxNjQ3ZTdkM2Y3
-    ZmI0MzllNTkwZGYzMTMwMmNkNzY4OWJkYzQ1ZjEyZmNmY2QzMzUwNDQzMzJm
-    OTQ2NTcyMzEwMzBmMWViY2E1MTcxZGNjNGQyNzhmMjc5Y2Q0ZWQ=
+    YzAzMmYzOTMyYmJmZDQ5M2RkZjJhNTc4ZDc1MGNjM2JmMWQ3NjY5YWZmYjJj
+    NjI4ZWI3N2VlYmZmYTRjODE0NmVkMDhmYjY4YTUxNjI3Nzg3MmYyZWU1OTli
+    M2U3MjE3NTg4NjU2MWY2MmNiNzIzYjkxNWJjZDVmMGM4Y2FhMjQ=

data/README.md

@@ -1,11 +1,8 @@
-Deploy tool made for Continuous Deployment.
+# Dpl
+ Dpl (dee-pee-ell) is a deploy tool made for continuous deployment.  Developed and used by Travis CI.
 
-Usage:
-
-    dpl --provider=heroku --api-key=`heroku auth:token`
-    dpl --provider=cloudControl --deployment='<application>/<deployment>' --email=<email> --password=<password>
-
-Supported providers:
+## Supported providers:
+Dpl supports the following providers:
 
 * AppFog
 * Cloud Foundry
@@ -19,3 +16,159 @@ Supported providers:
 * PyPi
 * RubyGems
 * S3
+
+## Installation:
+
+Dpl is published to rubygems. 
+
+* Dpl requires ruby with a version greater than 1.8.7
+* To install: `gem install dpl`
+
+## Usage:
+
+###Security Warning:
+
+Running dpl in a terminal that saves history is insecure as your password/api key will be saved as plain text by it.
+
+###Global Flags
+* `--provider=<provider>` sets the provider you want to deploy to. Every provider has slightly different flags, which are documented in the section about your provider following.
+*  Dpl will deploy by default from the latest commit. Use the `--skip_cleanup`  flag to deploy from the current file state. Note that many providers deploy by git and could ignore this option.
+
+
+### Heroku:
+
+#### Options:
+* **api-key**: Heroku API Key
+* **strategy[git/anvil]**: Deployment strategy for Dpl. Defaults to git.
+* **app**: Heroku app name. Defaults to the name of your git repo.
+* **username**: heroku username. Not necessary if api-key is used. Requires git strategy.
+* **password**: heroku password. Not necessary if api-key is used. Requires git strategy.
+
+#### Git vs Anvil Deploy:
+* Anvil will run the [buildpack](https://devcenter.heroku.com/articles/buildpacks) compilation step on the Travis CI VM, whereas the Git strategy will run it on a Heroku dyno, which provides the same environment the application will then run under and might be slightly faster.
+* The Git strategy allows using *user* and *password* instead of *api-key*.
+* When using Git, Heroku might send you an email for every deploy, as it adds a temporary SSH key to your account.
+
+As a rule of thumb, you should switch to the Git strategy if you run into issues with Anvil or if you're using the [user-env-compile](https://devcenter.heroku.com/articles/labs-user-env-compile) plugin.
+
+#### Examples:
+	
+    dpl --provider=heroku --api-key=`heroku auth:token`
+	dpl --provider=heroku --username=<username> --password=<password>
+    dpl --provider=heroku --api-key=`heroku auth:token` --strategy=anvil --app=<application>
+
+
+    
+
+### Nodejitsu:
+
+#### Options: 
+
+* **username**: Nodejitsu Username
+* **api-key**: Nodejitsu API Key
+
+#### Examples:
+	dpl --provider=nodejitsu --username=<username> --api-key=<api-key>
+
+### Engine Yard:
+
+#### Options:
+
+* **api-key**: Engine Yard Api Key
+* **username**: Engine Yard username. Not necessary if api-key is used. Requires git strategy.
+* **password**: Engine Yard password. Not necessary if api-key is used.
+* **app**: Engine Yard Application name. Defaults to git repo's name.
+* **environment**: Engine Yard Application Environment. Optional.
+* **migrate**: Engine Yard migration commands. Optional.
+
+#### Examples:
+
+	dpl --provider=engineyard --api-key=<api-key>
+    dpl --provider=engineyard --username=<username> --password=<password> --environment=staging
+	dpl --provider=engineyard --api-key=<api-key> --app=<application> --migrate=`rake db:migrate`
+
+### Openshift:
+
+#### Options:
+
+* **username**: Openshift Username.
+* **password**: Openshift Password.
+* **domain**: Openshift Application Domain.
+* **app**: Openshift Application. Defaults to git repo's name.
+
+####Examples:
+
+	dpl --provider=openshift --username=<username> --password=<password> --domain=<domain>
+	dpl --provider=openshift --username=<username> --password=<password> --domain=<domain> --app=<app>
+
+### cloudControl:
+
+#### Options:
+
+* **email**: cloudControll email.
+* **password**: cloudControll password.
+* **deployment**: cloudControll Deployment. Follows the format "APP_NAME/DEP_NAME".
+
+#### Examples:
+
+	dpl --provider=cloudcontroll --email=<email> --password<password> --deployment=`APP_NAME/DEP_NAME`
+
+### RubyGems:
+
+#### Options:
+
+* **api-key**: Rubygems Api Key.
+
+#### Examples:
+
+	dpl --provider=rubygems --api-key=<api-key>
+
+### PyPI:
+
+#### Options:
+
+* **user**: PyPI Username.
+* **password**: PyPI Password.
+* **server**: Optional. Only required if you want to release to a different index. Follows the form of "https://mypackageindex.com/index".
+
+#### Examples:
+
+	dpl --provider=pypi --user=<username> --password=<password>
+	dpl --provider=pypi --user=<username> --password=<password> --server=`https://mypackageindex.com/index`
+
+### NPM:
+
+#### Options:
+
+* **email**: NPM email.
+* **api-key**: NPM api key. Can be retrieved from your ~/.npmrc file.
+
+#### Examples:
+
+	dpl --provider=npm --email=<email> --api-key=<api-key>
+
+### S3:
+
+#### Options:
+
+* **acess-key-id**: AWS Access Key ID. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
+* **secret-access-key**: AWS Secret Key. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
+* **bucket**: S3 Bucket.
+
+#### Examples:
+
+	dpl --provider=s3 --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket>
+
+### Appfog:
+
+#### Options:
+
+* **email**: Appfog Email.
+* **password**: Appfog Password.
+* **app**: Appfog App. Defaults to git repo's name.
+
+#### Examples:
+
+	dpl --provider=appfog --email=<email> --password=<password>
+	dpl --provider=appfog --email=<email> --password=<password> --app=<app>
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dpl
 version: !ruby/object:Gem::Version
-  version: 1.5.2.travis.184.2
+  version: 1.5.2.travis.187.2
 platform: ruby
 authors:
 - Konstantin Haase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec