dpl-connect 1.8.43

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +7 -0
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +8 -0
  4. data/.rspec +2 -0
  5. data/.travis.yml +36 -0
  6. data/Gemfile +100 -0
  7. data/LICENSE +22 -0
  8. data/README.md +934 -0
  9. data/Rakefile +1 -0
  10. data/TESTING.md +29 -0
  11. data/bin/dpl +5 -0
  12. data/dpl.gemspec +32 -0
  13. data/lib/dpl/cli.rb +66 -0
  14. data/lib/dpl/error.rb +3 -0
  15. data/lib/dpl/provider.rb +264 -0
  16. data/lib/dpl/provider/anynines.rb +13 -0
  17. data/lib/dpl/provider/appfog.rb +21 -0
  18. data/lib/dpl/provider/atlas.rb +108 -0
  19. data/lib/dpl/provider/azure_webapps.rb +48 -0
  20. data/lib/dpl/provider/bintray.rb +509 -0
  21. data/lib/dpl/provider/bitballoon.rb +22 -0
  22. data/lib/dpl/provider/bluemix_cloud_foundry.rb +23 -0
  23. data/lib/dpl/provider/boxfuse.rb +57 -0
  24. data/lib/dpl/provider/catalyze.rb +49 -0
  25. data/lib/dpl/provider/chef_supermarket.rb +85 -0
  26. data/lib/dpl/provider/cloud66.rb +38 -0
  27. data/lib/dpl/provider/cloud_files.rb +38 -0
  28. data/lib/dpl/provider/cloud_foundry.rb +43 -0
  29. data/lib/dpl/provider/code_deploy.rb +123 -0
  30. data/lib/dpl/provider/deis.rb +119 -0
  31. data/lib/dpl/provider/divshot.rb +23 -0
  32. data/lib/dpl/provider/elastic_beanstalk.rb +195 -0
  33. data/lib/dpl/provider/engine_yard.rb +90 -0
  34. data/lib/dpl/provider/firebase.rb +27 -0
  35. data/lib/dpl/provider/gae.rb +97 -0
  36. data/lib/dpl/provider/gcs.rb +59 -0
  37. data/lib/dpl/provider/hackage.rb +29 -0
  38. data/lib/dpl/provider/heroku.rb +18 -0
  39. data/lib/dpl/provider/heroku/api.rb +98 -0
  40. data/lib/dpl/provider/heroku/generic.rb +94 -0
  41. data/lib/dpl/provider/heroku/git.rb +28 -0
  42. data/lib/dpl/provider/lambda.rb +236 -0
  43. data/lib/dpl/provider/launchpad.rb +48 -0
  44. data/lib/dpl/provider/modulus.rb +23 -0
  45. data/lib/dpl/provider/npm.rb +64 -0
  46. data/lib/dpl/provider/openshift.rb +59 -0
  47. data/lib/dpl/provider/ops_works.rb +132 -0
  48. data/lib/dpl/provider/packagecloud.rb +144 -0
  49. data/lib/dpl/provider/pages.rb +79 -0
  50. data/lib/dpl/provider/puppet_forge.rb +43 -0
  51. data/lib/dpl/provider/pypi.rb +111 -0
  52. data/lib/dpl/provider/releases.rb +139 -0
  53. data/lib/dpl/provider/rubygems.rb +51 -0
  54. data/lib/dpl/provider/s3.rb +123 -0
  55. data/lib/dpl/provider/scalingo.rb +97 -0
  56. data/lib/dpl/provider/script.rb +29 -0
  57. data/lib/dpl/provider/surge.rb +33 -0
  58. data/lib/dpl/provider/testfairy.rb +190 -0
  59. data/lib/dpl/provider/transifex.rb +45 -0
  60. data/lib/dpl/version.rb +3 -0
  61. data/notes/engine_yard.md +1 -0
  62. data/notes/heroku.md +3 -0
  63. data/spec/cli_spec.rb +36 -0
  64. data/spec/provider/anynines_spec.rb +20 -0
  65. data/spec/provider/appfog_spec.rb +35 -0
  66. data/spec/provider/atlas_spec.rb +99 -0
  67. data/spec/provider/azure_webapps_spec.rb +95 -0
  68. data/spec/provider/bintray_spec.rb +259 -0
  69. data/spec/provider/bitballoon_spec.rb +32 -0
  70. data/spec/provider/bluemixcloudfoundry_spec.rb +23 -0
  71. data/spec/provider/boxfuse_spec.rb +16 -0
  72. data/spec/provider/catalyze_spec.rb +39 -0
  73. data/spec/provider/chef_supermarket_spec.rb +51 -0
  74. data/spec/provider/cloud66_spec.rb +44 -0
  75. data/spec/provider/cloud_files_spec.rb +88 -0
  76. data/spec/provider/cloudfoundry_spec.rb +71 -0
  77. data/spec/provider/code_deploy_spec.rb +360 -0
  78. data/spec/provider/deis_spec.rb +116 -0
  79. data/spec/provider/divshot_spec.rb +28 -0
  80. data/spec/provider/elastic_beanstalk_spec.rb +209 -0
  81. data/spec/provider/firebase_spec.rb +40 -0
  82. data/spec/provider/gae_spec.rb +26 -0
  83. data/spec/provider/gcs_spec.rb +115 -0
  84. data/spec/provider/hackage_spec.rb +47 -0
  85. data/spec/provider/heroku_spec.rb +357 -0
  86. data/spec/provider/lambda_spec.rb +432 -0
  87. data/spec/provider/launchpad_spec.rb +33 -0
  88. data/spec/provider/modulus_spec.rb +29 -0
  89. data/spec/provider/npm_spec.rb +95 -0
  90. data/spec/provider/openshift_spec.rb +91 -0
  91. data/spec/provider/ops_works_spec.rb +127 -0
  92. data/spec/provider/packagecloud_spec.rb +56 -0
  93. data/spec/provider/puppet_forge_spec.rb +60 -0
  94. data/spec/provider/pypi_spec.rb +103 -0
  95. data/spec/provider/releases_spec.rb +303 -0
  96. data/spec/provider/rubygems_spec.rb +106 -0
  97. data/spec/provider/s3_spec.rb +174 -0
  98. data/spec/provider/scalingo_spec.rb +64 -0
  99. data/spec/provider/script_spec.rb +26 -0
  100. data/spec/provider/surge_spec.rb +15 -0
  101. data/spec/provider/testfairy_spec.rb +86 -0
  102. data/spec/provider/transifex_spec.rb +110 -0
  103. data/spec/provider_spec.rb +210 -0
  104. data/spec/spec_helper.rb +20 -0
  105. metadata +279 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 6ddada0e8f36e1861ca9f442725bb0db8add9760
4
+ data.tar.gz: 458b50c1c8c4b2b1176073b44687053c28d4cb1a
5
+ SHA512:
6
+ metadata.gz: 40b9d03c13491c6bd07f6f099617cf86c92f3ab32edd14dddaa91c45816a93a98a8f06db7f332495881f246f3706f3f7ef313df963f853de750b89c882a5b0cc
7
+ data.tar.gz: 34f30a173305e28544f435d8ee0433408e916ae7b0bfd0061a1c3ca9095eed3a9eeee1d417932acf191b9039a9e7edd167d33803f2bacb52aecbc317ac926b3d
@@ -0,0 +1 @@
1
+ service_name: travis-ci
@@ -0,0 +1,8 @@
1
+ Gemfile.lock
2
+ .coverage
3
+ coverage
4
+ .dpl
5
+ setuptools*.zip
6
+ google_appengine_*.zip
7
+ google_appengine/*
8
+ npm-debug.log
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --tty
@@ -0,0 +1,36 @@
1
+ language: ruby
2
+ rvm:
3
+ - 1.9.3
4
+ - 2.0.0
5
+ - 2.1.5
6
+ - "2.2.5"
7
+ - "2.3.1"
8
+
9
+ matrix:
10
+ include:
11
+ - rvm: "2.2.6"
12
+ sudo: required
13
+ allow_failures:
14
+ - rvm: "2.3.1"
15
+
16
+ sudo: false
17
+
18
+ cache: bundler
19
+
20
+ before_install:
21
+ - gem update bundler
22
+
23
+ script:
24
+ - bundle exec rake && gem build dpl.gemspec && gem install dpl-*.gem && dpl --provider=script --script='echo foo'
25
+
26
+ deploy:
27
+ provider: rubygems
28
+ api_key:
29
+ secure: ZmZoDL1tilWvQrqRWDm2K4xQ5Grt9eRJzYVZPLANR0P1TM5BJBLk+UhWCWCPkkDVIBWMa5ANsiFYBxtH65Lw+uqMztSpVusk0l0LQXZGv9jMpT9445A8008U3vvfS0ke7IG8Q4bMAC7Sd6VGaiHDyZC7zmNvnqMpmVX7ShcgBME=
30
+ gem: dpl
31
+ on:
32
+ repo: travis-ci/dpl
33
+ ruby: 2.2.6
34
+
35
+ notifications:
36
+ webhooks: "http://requestb.in/1guaq7t1"
data/Gemfile ADDED
@@ -0,0 +1,100 @@
1
+ source 'https://rubygems.org'
2
+ gemspec
3
+
4
+ gem 'term-ansicolor', '~> 1.3.2'
5
+
6
+ platforms :mri_19 do
7
+ gem 'slop', '~> 3.6.0'
8
+ gem 'ohai', '~> 7.4.0'
9
+ gem 'amq-protocol', '~> 1.9.2'
10
+ gem 'net-ssh', '~> 2.9.2'
11
+ end
12
+
13
+ group :heroku do
14
+ gem 'rendezvous', '~> 0.0.2'
15
+ gem 'heroku-api', '= 0.3.16'
16
+ gem 'anvil-cli', '~> 0.16.1'
17
+ gem 'netrc'
18
+ gem 'faraday'
19
+ end
20
+
21
+ group :openshift do
22
+ gem 'rhc'
23
+ gem 'httpclient'
24
+ end
25
+
26
+ group :appfog do
27
+ gem 'json_pure'
28
+ gem 'af'
29
+ end
30
+
31
+ group :rubygems do
32
+ gem 'gems', '~> 0.8.3'
33
+ end
34
+
35
+ group :sss do
36
+ gem 'aws-sdk', '~> 2.10.39', '< 3.0'
37
+ gem 'mime-types'
38
+ end
39
+
40
+ group :code_deploy do
41
+ gem 'aws-sdk', '~> 2.10.39', '< 3.0'
42
+ end
43
+
44
+ group :lambda do
45
+ gem 'aws-sdk', '~> 2.10.39', '< 3.0'
46
+ gem 'rubyzip', '~> 1.1'
47
+ end
48
+
49
+ group :cloud_files do
50
+ gem 'fog-google', '< 0.1.1', platforms: :mri_19
51
+ gem 'fog-profitbricks', '< 2.0', platforms: :mri_19
52
+ gem 'fog'
53
+ gem 'nokogiri', '~> 1.6.8.1'
54
+ end
55
+
56
+ group :releases do
57
+ gem 'octokit', '~> 4.3.0'
58
+ end
59
+
60
+ group :gcs do
61
+ gem 'gstore'
62
+ gem 'mime-types'
63
+ end
64
+
65
+ group :elastic_beanstalk do
66
+ gem 'aws-sdk', '~> 2.10.39', '< 3.0'
67
+ gem 'rubyzip', '~> 1.1'
68
+ end
69
+
70
+ group :bitballoon do
71
+ gem 'bitballoon'
72
+ gem 'jwt', '< 1.5.3', platforms: :mri_19
73
+ end
74
+
75
+ group :puppet_forge do
76
+ gem 'json_pure'
77
+ gem 'puppet'
78
+ gem 'puppet-blacksmith'
79
+ end
80
+
81
+ group :packagecloud do
82
+ gem 'json_pure'
83
+ gem 'packagecloud-ruby', '= 0.2.17'
84
+ end
85
+
86
+ group :testfairy do
87
+ gem 'multipart-post'
88
+ end
89
+
90
+ group :chef_supermarket do
91
+ gem 'chef'
92
+ end
93
+
94
+ group :deis do
95
+ gem 'git'
96
+ end
97
+
98
+ group :opsworks do
99
+ gem 'aws-sdk', '~> 2.10.39', '< 3.0'
100
+ end
data/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Konstantin Haase
2
+
3
+ Permission is hereby granted, free of charge, to any person
4
+ obtaining a copy of this software and associated documentation
5
+ files (the "Software"), to deal in the Software without
6
+ restriction, including without limitation the rights to use,
7
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the
9
+ Software is furnished to do so, subject to the following
10
+ conditions:
11
+
12
+ The above copyright notice and this permission notice shall be
13
+ included in all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
+ OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,934 @@
1
+ # Dpl [![Build Status](https://travis-ci.org/travis-ci/dpl.svg?branch=master)](https://travis-ci.org/travis-ci/dpl) [![Code Climate](https://codeclimate.com/github/travis-ci/dpl.png)](https://codeclimate.com/github/travis-ci/dpl) [![Gem Version](https://badge.fury.io/rb/dpl.png)](http://badge.fury.io/rb/dpl) [![Coverage Status](https://coveralls.io/repos/travis-ci/dpl/badge.svg?branch=master&service=github)](https://coveralls.io/github/travis-ci/dpl?branch=master)
2
+
3
+ ## Writing and Testing a New Deployment Provider and new functionality
4
+
5
+ See [TESTING.md](TESTING.md).
6
+
7
+ ## Supported Providers:
8
+ Dpl supports the following providers:
9
+
10
+ * [Anynines](#anynines)
11
+ * [AppFog](#appfog)
12
+ * [Atlas by HashiCorp](#atlas)
13
+ * [AWS CodeDeploy](#aws-codedeploy)
14
+ * [AWS Elastic Beanstalk](#elastic-beanstalk)
15
+ * [AWS OpsWorks](#opsworks)
16
+ * [AWS S3](#s3)
17
+ * [Azure Web Apps](#azure-web-apps)
18
+ * [Bintray](#bintray)
19
+ * [BitBalloon](#bitballoon)
20
+ * [Bluemix Cloud Foundry](#bluemix-cloud-foundry)
21
+ * [Boxfuse](#boxfuse)
22
+ * [Catalyze](#catalyze)
23
+ * [Chef Supermarket](#chef-supermarket)
24
+ * [Cloud 66](#cloud-66)
25
+ * [Cloud Foundry](#cloud-foundry)
26
+ * [Deis](#deis)
27
+ * [Divshot.io](#divshotio)
28
+ * [Engine Yard](#engine-yard)
29
+ * [Firebase](#firebase)
30
+ * [Github Pages](#github-pages)
31
+ * [Github Releases](#github-releases)
32
+ * [Google App Engine (experimental)](#google-app-engine)
33
+ * [Google Cloud Storage](#google-cloud-storage)
34
+ * [Hackage](#hackage)
35
+ * [Heroku](#heroku)
36
+ * [Lambda](#lambda)
37
+ * [Launchpad](#launchpad)
38
+ * [Modulus](#modulus)
39
+ * [Nodejitsu](#nodejitsu)
40
+ * [NPM](#npm)
41
+ * [OpenShift](#openshift)
42
+ * [packagecloud](#packagecloud)
43
+ * [Puppet Forge](#puppet-forge)
44
+ * [PyPi](#pypi)
45
+ * [Rackspace Cloud Files](#rackspace-cloud-files)
46
+ * [RubyGems](#rubygems)
47
+ * [Scalingo](#scalingo)
48
+ * [Script](#script)
49
+ * [Surge.sh](#surgesh)
50
+ * [TestFairy](#testfairy)
51
+
52
+ ## Installation:
53
+
54
+ Dpl is published to rubygems.
55
+
56
+ * Dpl requires ruby with a version greater than 1.9.3
57
+ * To install: `gem install dpl`
58
+
59
+ ## Usage:
60
+
61
+ ### Security Warning:
62
+
63
+ Running dpl in a terminal that saves history is insecure as your password/api key will be saved as plain text by it.
64
+
65
+ ### Global Flags
66
+ * `--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.
67
+ * 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.
68
+
69
+ ### Heroku:
70
+
71
+ #### Options:
72
+ * **api-key**: Heroku API Key
73
+ * **strategy**: Deployment strategy for Dpl. Defaults to `api`. The other option is `git`.
74
+ * **app**: Heroku app name. Defaults to the name of your git repo.
75
+ * **username**: heroku username. Not necessary if api-key is used. Requires git strategy.
76
+ * **password**: heroku password. Not necessary if api-key is used. Requires git strategy.
77
+
78
+ #### API vs Git Deploy:
79
+ * API deploy will tar up the current directory (minus the git repo) and send it to Heroku.
80
+ * Git deploy will send the contents of the git repo only, so may not contain any local changes.
81
+ * The Git strategy allows using *user* and *password* instead of *api-key*.
82
+ * When using Git, Heroku might send you an email for every deploy, as it adds a temporary SSH key to your account.
83
+
84
+ #### Examples:
85
+
86
+ dpl --provider=heroku --api-key=`heroku auth:token`
87
+ dpl --provider=heroku --strategy=git --username=<username> --password=<password> --app=<application>
88
+
89
+
90
+ ### Bintray:
91
+
92
+ #### Options:
93
+
94
+ * **file**: Path to a descriptor file, containing information for the Bintray upload.
95
+ * **user**: Bintray user
96
+ * **key**: Bintray API key
97
+ * **passphrase**: Optional. In case a passphrase is configured on Bintray and GPG signing is used.
98
+ * **dry-run**: Optional. If set to true, skips sending requests to Bintray. Useful for testing your configuration.
99
+
100
+ #### Descriptor file example:
101
+ ```groovy
102
+ {
103
+ /* Bintray package information.
104
+ In case the package already exists on Bintray, only the name, repo and subject
105
+ fields are mandatory. */
106
+
107
+ "package": {
108
+ "name": "auto-upload", // Bintray package name
109
+ "repo": "myRepo", // Bintray repository name
110
+ "subject": "myBintrayUser", // Bintray subject (user or organization)
111
+ "desc": "I was pushed completely automatically",
112
+ "website_url": "www.jfrog.com",
113
+ "issue_tracker_url": "https://github.com/bintray/bintray-client-java/issues",
114
+ "vcs_url": "https://github.com/bintray/bintray-client-java.git",
115
+ "github_use_tag_release_notes": true,
116
+ "github_release_notes_file": "RELEASE.txt",
117
+ "licenses": ["MIT"],
118
+ "labels": ["cool", "awesome", "gorilla"],
119
+ "public_download_numbers": false,
120
+ "public_stats": false,
121
+ "attributes": [{"name": "att1", "values" : ["val1"], "type": "string"},
122
+ {"name": "att2", "values" : [1, 2.2, 4], "type": "number"},
123
+ {"name": "att5", "values" : ["2014-12-28T19:43:37+0100"], "type": "date"}]
124
+ },
125
+
126
+ /* Package version information.
127
+ In case the version already exists on Bintray, only the name fields is mandatory. */
128
+
129
+ "version": {
130
+ "name": "0.5",
131
+ "desc": "This is a version",
132
+ "released": "2015-01-04",
133
+ "vcs_tag": "0.5",
134
+ "attributes": [{"name": "VerAtt1", "values" : ["VerVal1"], "type": "string"},
135
+ {"name": "VerAtt2", "values" : [1, 3.2, 5], "type": "number"},
136
+ {"name": "VerAtt3", "values" : ["2015-01-01T19:43:37+0100"], "type": "date"}],
137
+ "gpgSign": false
138
+ },
139
+
140
+ /* Configure the files you would like to upload to Bintray and their upload path.
141
+ You can define one or more groups of patterns.
142
+ Each group contains three patterns:
143
+
144
+ includePattern: Pattern in the form of Ruby regular expression, indicating the path of files to be uploaded to Bintray.
145
+ excludePattern: Optional. Pattern in the form of Ruby regular expression, indicating the path of files to be removed from the list of files specified by the includePattern.
146
+ uploadPattern: Upload path on Bintray. The path can contain symbols in the form of $1, $2,... that are replaced with capturing groups defined in the include pattern.
147
+
148
+ In the example below, the following files are uploaded,
149
+ 1. All gem files located under build/bin/ (including sub directories),
150
+ except for files under a the do-not-deploy directory.
151
+ The files will be uploaded to Bintray under the gems folder.
152
+ 2. All files under build/docs. The files will be uploaded to Bintray under the docs folder.
153
+
154
+ Note: Regular expressions defined as part of the includePattern property must be wrapped with brackets. */
155
+
156
+ "files":
157
+ [
158
+ {"includePattern": "build/bin(.*)*/(.*\.gem)", "excludePattern": ".*/do-not-deploy/.*", "uploadPattern": "gems/$2"},
159
+ {"includePattern": "build/docs/(.*)", "uploadPattern": "docs/$1"}
160
+ ],
161
+ "publish": true
162
+ }
163
+ ```
164
+
165
+ #### Debian Upload
166
+
167
+ When artifacts are uploaded to a Debian repository using the Automatic index layout, the Debian distribution information is required and must be specified. The information is specified in the descriptor file by the matrixParams as part of the files closure as shown in the following example:
168
+ ```groovy
169
+ "files":
170
+ [{"includePattern": "build/bin/(.*\.deb)", "uploadPattern": "$1",
171
+ "matrixParams": {
172
+ "deb_distribution": "vivid",
173
+ "deb_component": "main",
174
+ "deb_architecture": "amd64"}
175
+ }
176
+ ]
177
+ ```
178
+
179
+ #### Examples:
180
+ dpl --provider=bintray --file=<path> --user=<username> --key=<api-key>
181
+ dpl --provider=bintray --file=<path> --user=<username> --key=<api-key> --passphrase=<passphrase>
182
+
183
+
184
+ ### Boxfuse
185
+
186
+ Boxfuse will transform your .jar or .war file of your JVM-based application into a minimal machine image based upon which it will launch EC2 instances on AWS.
187
+
188
+ #### Options
189
+
190
+ * **user**: Your Boxfuse user
191
+ * **secret**: Your Boxfuse secret
192
+ * **configfile**: The Boxfuse configuration file to use (default: boxfuse.conf)
193
+ * **payload**: The file to use as a payload for the image
194
+ * **app**: The Boxfuse app to deploy (default: auto-detected based on payload file name)
195
+ * **version**: The version to assign to the image (default: auto-detected based on payload file name)
196
+ * **env**: The Boxfuse environment to deploy to (default: test)
197
+
198
+ All options can also be configured directly in boxfuse.conf as described in [the documentation](https://boxfuse.com/docs/commandline/#configuration).
199
+
200
+ #### Environment Variables
201
+
202
+ For authentication you can also use Travis CI secure environment variable:
203
+
204
+ * **BOXFUSE_USER**: Your Boxfuse user
205
+ * **BOXFUSE_SECRET**: Your Boxfuse secret
206
+
207
+ #### Examples
208
+ dpl --provider=boxfuse
209
+ dpl --provider=boxfuse --user=<your-boxfuse-user> --secret=<your-boxfuse-secret> --env=<your-boxfuse-environment>
210
+ dpl --provider=boxfuse --configfile=<your-boxfuse-config-file>
211
+
212
+
213
+ ### Nodejitsu:
214
+
215
+ #### Options:
216
+
217
+ * **username**: Nodejitsu Username
218
+ * **api-key**: Nodejitsu API Key
219
+
220
+ #### Examples:
221
+ dpl --provider=nodejitsu --username=<username> --api-key=<api-key>
222
+
223
+
224
+ ### Modulus
225
+
226
+ #### Options:
227
+
228
+ * **api-key** Modulus Authentication Token
229
+ * **project-name** Modulus Project to Deploy
230
+
231
+ #### Example:
232
+ dpl --provider=modulus --api-key=<api-key> --project-name=<project-name>
233
+
234
+
235
+ ### Engine Yard:
236
+
237
+ #### Options:
238
+
239
+ * **api-key**: Engine Yard Api Key
240
+ * **username**: Engine Yard username. Not necessary if api-key is used. Requires git strategy.
241
+ * **password**: Engine Yard password. Not necessary if api-key is used.
242
+ * **app**: Engine Yard Application name. Defaults to git repo's name.
243
+ * **environment**: Engine Yard Application Environment. Optional.
244
+ * **migrate**: Engine Yard migration commands. Optional.
245
+
246
+ #### Examples:
247
+
248
+ dpl --provider=engineyard --api-key=<api-key>
249
+ dpl --provider=engineyard --username=<username> --password=<password> --environment=staging
250
+ dpl --provider=engineyard --api-key=<api-key> --app=<application> --migrate=`rake db:migrate`
251
+
252
+ ### OpenShift:
253
+
254
+ #### Options:
255
+
256
+ * **user**: Openshift Username.
257
+ * **password**: Openshift Password.
258
+ * **domain**: Openshift Application Domain.
259
+ * **app**: Openshift Application. Defaults to git repo's name.
260
+
261
+ #### Examples:
262
+
263
+ dpl --provider=openshift --user=<username> --password=<password> --domain=<domain>
264
+ dpl --provider=openshift --user=<username> --password=<password> --domain=<domain> --app=<app>
265
+
266
+ ### RubyGems:
267
+
268
+ #### Options:
269
+
270
+ * **api-key**: Rubygems Api Key.
271
+
272
+ #### Examples:
273
+
274
+ dpl --provider=rubygems --api-key=<api-key>
275
+
276
+ ### PyPI:
277
+
278
+ #### Options:
279
+
280
+ * **user**: PyPI Username.
281
+ * **password**: PyPI Password.
282
+ * **server**: Optional. Only required if you want to release to a different index. Follows the form of 'https://mypackageindex.com/index'. Defaults to 'https://upload.pypi.org/legacy/'.
283
+ * **distributions**: Optional. A space-separated list of distributions to be uploaded to PyPI. Defaults to 'sdist'.
284
+ * **skip_upload_docs**: Optional. When set to `false`, documentation is uploaded. Defaults to `true`.
285
+ Note that upload.pypi.org does not support document uploading. If you set
286
+ this option to `false`, your deployment fails, unless you specify the server
287
+ that supports this option. See https://github.com/travis-ci/dpl/issues/660
288
+ for details.
289
+ * **docs_dir**: Optional. A path to the directory to upload documentation from. Defaults to 'build/docs'
290
+
291
+ #### Environment variables:
292
+
293
+ * **PYPI_USER**: PyPI Username. Used if the `user` option is omitted.
294
+ * **PYPI_PASSWORD**: PyPI Password. Used if the `password` option is omitted.
295
+ * **PYPI_SERVER** Optional. Only required if you want to release to a different index. Used if the `server` option is omitted.
296
+ * **PYPI_DISTRIBUTIONS** Optional. A space-separated list of distributions to be uploaded to PyPI. Used if the `distributions` option is omitted.
297
+ * **PYPI_DOCS_DIR** Optional. A path to the directory to upload documentation from. Used if the `docs_dir` option is omitted.
298
+
299
+ #### Examples:
300
+
301
+ dpl --provider=pypi --user=<username> --password=<password>
302
+ dpl --provider=pypi --user=<username> --password=<password> --server='https://mypackageindex.com/index' --distributions='sdist bdist_wheel'
303
+
304
+ ### NPM:
305
+
306
+ #### Options:
307
+
308
+ * **email**: NPM email.
309
+ * **api-key**: NPM api key. Can be retrieved from your ~/.npmrc file.
310
+
311
+ #### Examples:
312
+
313
+ dpl --provider=npm --email=<email> --api-key=<api-key>
314
+
315
+ ### S3:
316
+
317
+ #### Options:
318
+
319
+ * **access-key-id**: AWS Access Key ID. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
320
+ * **secret-access-key**: AWS Secret Key. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
321
+ * **bucket**: S3 Bucket.
322
+ * **region**: S3 Region. Defaults to us-east-1.
323
+ * **upload-dir**: S3 directory to upload to. Defaults to root directory.
324
+ * **storage-class**: S3 storage class to upload as. Defaults to "STANDARD". Other values are "STANDARD_IA" or "REDUCED_REDUNDANCY". Details can be found [here](https://aws.amazon.com/s3/storage-classes/).
325
+ * **server-side-encryption**: When set to `true`, use S3 Server Side Encryption (SSE-AES256). Defaults to `false`.
326
+ * **local-dir**: Local directory to upload from. Can be set from a global perspective (~/travis/build) or relative perspective (build) Defaults to project root.
327
+ * **detect-encoding**: Set HTTP header `Content-Encoding` for files compressed with `gzip` and `compress` utilities. Defaults to not set.
328
+ * **cache_control**: Set HTTP header `Cache-Control` to suggest that the browser cache the file. Defaults to `no-cache`. Valid options are `no-cache`, `no-store`, `max-age=<seconds>`,`s-maxage=<seconds>` `no-transform`, `public`, `private`.
329
+ * **expires**: This sets the date and time that the cached object is no longer cacheable. Defaults to not set. The date must be in the format `YYYY-MM-DD HH:MM:SS -ZONE`.
330
+ * **acl**: Sets the access control for the uploaded objects. Defaults to `private`. Valid options are `private`, `public_read`, `public_read_write`, `authenticated_read`, `bucket_owner_read`, `bucket_owner_full_control`.
331
+ * **dot_match**: When set to `true`, upload files starting a `.`.
332
+ * **index_document_suffix**: Set the index document of a S3 website.
333
+ * **default_text_charset**: Set the default character set to append to the content-type of text files you are uploading.
334
+
335
+ #### File-specific `Cache-Control` and `Expires` headers
336
+
337
+ It is possible to set file-specific `Cache-Control` and `Expires` headers using `value: file[, file]` format.
338
+
339
+ #### Environment variables:
340
+
341
+ * **AWS_ACCESS_KEY_ID**: AWS Access Key ID. Used if the `access-key-id` option is omitted.
342
+ * **AWS_SECRET_ACCESS_KEY**: AWS Secret Key. Used if the `secret-access-key` option is omitted.
343
+
344
+ ##### Example:
345
+
346
+ --cache_control="no-cache: index.html"
347
+ --expires="\"2012-12-21 00:00:00 -0000\": *.css, *.js"
348
+
349
+ #### Examples:
350
+
351
+ dpl --provider=s3 --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket> --acl=public_read
352
+ dpl --provider=s3 --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket> --detect-encoding --cache_control=max-age=99999 --expires="2012-12-21 00:00:00 -0000"
353
+ dpl --provider=s3 --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket> --region=us-west-2 --local-dir=BUILD --upload-dir=BUILDS
354
+
355
+ ### Elastic Beanstalk:
356
+
357
+ #### Options:
358
+
359
+ * **access-key-id**: AWS Access Key ID. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
360
+ * **secret-access-key**: AWS Secret Key. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
361
+ * **region**: AWS Region the Elastic Beanstalk app is running in. Defaults to 'us-east-1'. Please be aware that this must match the region of the elastic beanstalk app.
362
+ * **app**: Elastic Beanstalk application name.
363
+ * **env**: Elastic Beanstalk environment name which will be updated.
364
+ * **zip_file**: The zip file that you want to deploy. _**Note:**_ you also need to use the `skip_cleanup` or the zip file you are trying to upload will be removed during cleanup.
365
+ * **bucket_name**: Bucket name to upload app to.
366
+ * **bucket_path**: Location within Bucket to upload app to.
367
+ * **only_create_app_version**: only create the app version, don't actually deploy it.
368
+
369
+ #### Environment variables:
370
+
371
+ * **ELASTIC_BEANSTALK_ENV**: Elastic Beanstalk environment name which will be updated. Is only used if `env` option is omitted.
372
+ * **ELASTIC_BEANSTALK_LABEL**: Label name of the new version.
373
+ * **ELASTIC_BEANSTALK_DESCRIPTION**: Description of the new version. Defaults to the last commit message.
374
+
375
+ #### Examples:
376
+
377
+ dpl --provider=elasticbeanstalk --access-key-id=<access-key-id> --secret-access-key="<secret-access-key>" --app="example-app-name" --env="example-app-environment" --region="us-west-2"
378
+
379
+ ### OpsWorks:
380
+
381
+ #### Options:
382
+
383
+ * **access-key-id**: AWS Access Key ID. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
384
+ * **secret-access-key**: AWS Secret Key. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
385
+ * **app-id**: The app ID.
386
+ * **instance-ids**: An instance id. (Use this option multiple times to specify multiple instance ids. Default: [])
387
+ * **layer-ids**: A layer id. (Use this option multiple times to specify multiple layer ids. Default: [])
388
+ * **migrate**: Migrate the database. (Default: false)
389
+ * **wait-until-deployed**: Wait until the app is deployed and return the deployment status. (Default: false)
390
+ * **custom_json**: Override custom_json options. If using this, default configuration will be overriden. See the code [here](https://github.com/travis-ci/dpl/blob/master/lib/dpl/provider/ops_works.rb#L43). More about `custom_json` [here](http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json.html).
391
+
392
+ #### Environment variables:
393
+
394
+ * **AWS_ACCESS_KEY_ID**: AWS Access Key ID. Used if the `access-key-id` option is omitted.
395
+ * **AWS_SECRET_ACCESS_KEY**: AWS Secret Key. Used if the `secret-access-key` option is omitted.
396
+
397
+ #### Examples:
398
+
399
+ dpl --provider=opsworks --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --app-id=<app-id> --migrate --wait-until-deployed
400
+ dpl --provider=opsworks --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --app-id=<app-id> --layer-ids=<layer-id>
401
+
402
+ ### Anynines:
403
+
404
+ #### Options:
405
+
406
+ * **username**: anynines username.
407
+ * **password**: anynines password.
408
+ * **organization**: anynines target organization.
409
+ * **space**: anynines target space
410
+
411
+ #### Examples:
412
+
413
+ dpl --provider=anynines --username=<username> --password=<password> --organization=<organization> --space=<space>
414
+
415
+ ### Appfog:
416
+
417
+ #### Options:
418
+
419
+ * **email**: Appfog Email.
420
+ * **password**: Appfog Password.
421
+ * **app**: Appfog App. Defaults to git repo's name.
422
+
423
+ #### Examples:
424
+
425
+ dpl --provider=appfog --email=<email> --password=<password>
426
+ dpl --provider=appfog --email=<email> --password=<password> --app=<app>
427
+
428
+ ### Atlas:
429
+
430
+ The Atlas provider uses the [`atlas-upload-cli`](https://github.com/hashicorp/atlas-upload-cli) command. The [Atlas Upload CLI](https://github.com/hashicorp/atlas-upload-cli) is a lightweight command line interface for uploading application code to [Atlas](https://atlas.hashicorp.com/homepage?utm_source=github&utm_medium=travis-ci&utm_campaign=dpl) to kick off Atlas-based deployment processes from Travis CI.
431
+
432
+ You first need to create an [Atlas account](https://atlas.hashicorp.com/account/new?utm_source=github&utm_medium=travis-ci&utm_campaign=dpl), then, generate an [Atlas API token](https://atlas.hashicorp.com/settings/tokens) for Travis CI.
433
+
434
+ #### Options:
435
+
436
+ * **token** (Required): Atlas API token.
437
+ * **app** (Required): Atlas application name (`<atlas-username>/<app-name>`).
438
+ * **exclude**: Glob pattern of files or directories to exclude (this may be specified multiple times).
439
+ * **include**: Glob pattern of files/directories to include (this may be specified multiple times, any excludes will override conflicting includes).
440
+ * **address**: The address of the Atlas server.
441
+ * **vcs**: Use VCS to determine which files to include/exclude.
442
+ * **metadata**: Arbitrary key-value (string) metadata to be sent with the upload; may be specified multiple times.
443
+ * **debug**: Turn on debug output.
444
+ * **version**: Print the version of this application.
445
+
446
+ #### Examples:
447
+
448
+ dpl --provider=atlas --token=ATLAS_TOKEN --app=ATLAS_USERNAME/APP_NAME
449
+ dpl --provider=atlas --token=ATLAS_TOKEN --app=ATLAS_USERNAME/APP_NAME --debug --vcs --version
450
+ dpl --provider=atlas --token=ATLAS_TOKEN --app=ATLAS_USERNAME/APP_NAME --exclude="*.log" --include="build/*" --include="bin/*"
451
+ dpl --provider=atlas --token=ATLAS_TOKEN --app=ATLAS_USERNAME/APP_NAME --metadata="foo=bar" --metadata="bar=baz"
452
+
453
+ ### Azure Web Apps:
454
+
455
+ #### Options:
456
+
457
+ * **site**: Web App Name (if your app lives at myapp.azurewebsites.net, the name would be myapp).
458
+ * **slot**: Optional. Slot name if your app uses staging deployment. (e.g. if your slot lives at myapp-test.azurewebsites.net, the slot would be myapp-test).
459
+ * **username**: Web App Deployment Username.
460
+ * **password**: Web App Deployment Password.
461
+ * **verbose**: If passed, Azure's deployment output will be printed. Warning: If you provide incorrect credentials, Git will print those in clear text. Correct authentication credentials will remain hidden.
462
+
463
+ #### Environment variables:
464
+
465
+ * **AZURE_WA_SITE** Web App Name. Used if the `site` option is omitted.
466
+ * **AZURE_WA_SLOT** Optional. Slot name if your app uses staging deployment. Used if the `slot` option is omitted.
467
+ * **AZURE_WA_USERNAME**: Web App Deployment Username. Used if the `username` option is omitted.
468
+ * **AZURE_WA_PASSWORD**: Web App Deployment Password. Used if the `password` option is omitted.
469
+
470
+ #### Examples:
471
+
472
+ dpl --provider=AzureWebApps --username=depluser --password=deplp@ss --site=dplsite --slot=dplsite-test --verbose
473
+
474
+ ### Divshot.io:
475
+
476
+ #### Options:
477
+
478
+ * **api-key**: Divshot.io API key
479
+ * **environment**: Which environment (development, staging, production) to deploy to
480
+
481
+ #### Examples:
482
+
483
+ dpl --provider=divshot --api-key=<api-key> --environment=<environment>
484
+
485
+ ### Cloud Foundry:
486
+
487
+ #### Options:
488
+
489
+ * **username**: Cloud Foundry username.
490
+ * **password**: Cloud Foundry password.
491
+ * **organization**: Cloud Foundry target organization.
492
+ * **api**: Cloud Foundry api URL
493
+ * **space**: Cloud Foundry target space
494
+ * **manifest**: Path to manifest file. Optional.
495
+ * **skip_ssl_validation**: Skip ssl validation. Optional.
496
+
497
+ #### Examples:
498
+
499
+ dpl --provider=cloudfoundry --username=<username> --password=<password> --organization=<organization> --api=<api> --space=<space> --skip-ssl-validation
500
+
501
+ ### Rackspace Cloud Files:
502
+
503
+ #### Options:
504
+
505
+ * **username**: Rackspace Username.
506
+ * **api-key**: Rackspace API Key.
507
+ * **region**: Cloud Files Region. The region in which your Cloud Files container exists.
508
+ * **container**: Container Name. The container where you would like your files to be uploaded.
509
+ * **dot_match**: When set to `true`, upload files starting a `.`.
510
+
511
+ #### Examples:
512
+
513
+ dpl --provider=cloudfiles --username=<username> --api-key=<api-key> --region=<region> --container=<container>
514
+
515
+ ### GitHub Pages:
516
+
517
+ #### Options:
518
+
519
+ * **github-token**: GitHub oauth token with `repo` permission.
520
+ * **repo**: Repo slug, defaults to current one.
521
+ * **target-branch**: Branch to push force to, defaults to gh-pages.
522
+ * **local-dir**: Directory to push to GitHub Pages, defaults to current.
523
+ * **fqdn**: Optional, no default, sets a main domain for your website.
524
+ * **project-name**: Defaults to fqdn or repo slug, used for metadata.
525
+ * **email**: Optional, comitter info, defaults to deploy@travis-ci.org.
526
+ * **name**: Optional, comitter, defaults to Deployment Bot.
527
+
528
+ #### Examples:
529
+
530
+ dpl --provider=pages --github-token=<api-key> --local-dir=build
531
+
532
+ ### GitHub Releases:
533
+
534
+ #### Options:
535
+
536
+ * **api-key**: GitHub oauth token with `public_repo` or`repo` permission.
537
+ * **user**: GitHub username. Not necessary if `api-key` is used.
538
+ * **password**: GitHub Password. Not necessary if `api-key` is used.
539
+ * **repo**: GitHub Repo. Defaults to git repo's name.
540
+ * **file**: File to upload to GitHub Release.
541
+ * **file_glob**: If files should be interpreted as globs (\* and \*\* wildcards). Defaults to false.
542
+ * **overwrite**: If files with the same name should be overwritten. Defaults to false.
543
+ * **release-number**: Overide automatic release detection, set a release manually.
544
+ * **prerelease**: Identify the release as a prerelease.
545
+
546
+ Additionally, options can be passed to [Octokit](https://github.com/octokit/octokit.rb) client.
547
+ These are documented in https://github.com/octokit/octokit.rb/blob/master/lib/octokit/client/releases.rb.
548
+
549
+ #### GitHub Two Factor Authentication
550
+
551
+ For accounts using two factor authentication, you have to use an oauth token as a username and password will not work.
552
+
553
+ #### Examples:
554
+
555
+ dpl --provider=releases --api-key=<api-key> --file=build.tar.gz
556
+
557
+ ### Cloud 66
558
+
559
+ #### Options:
560
+
561
+ * **redeployment_hook**: The redeployment hook URL. Available from the Information menu within the Cloud 66 portal.
562
+
563
+ #### Examples:
564
+
565
+ dpl --provider=cloud66 --redeployment_hook=<url>
566
+
567
+ ### Hackage:
568
+
569
+ #### Options:
570
+
571
+ * **username**: Hackage username.
572
+ * **password**: Hackage password.
573
+
574
+ #### Examples:
575
+
576
+ dpl --provider=hackage --username=<username> --password=<password>
577
+
578
+ ### Deis:
579
+
580
+ #### Options:
581
+
582
+ * **controller**: Deis controller e.g. deis.deisapps.com
583
+ * **username**: Deis username
584
+ * **password**: Deis password
585
+ * **app**: Deis app
586
+ * **cli_version**: Install a specific deis cli version
587
+
588
+ #### Examples:
589
+
590
+ dpl --provider=deis --controller=deis.deisapps.com --username=travis --password=secret --app=example
591
+
592
+ ### Google Cloud Storage:
593
+
594
+ #### Options:
595
+
596
+ * **access-key-id**: GCS Interoperable Access Key ID. Info about Interoperable Access Key from [here](https://developers.google.com/storage/docs/migrating).
597
+ * **secret-access-key**: GCS Interoperable Access Secret.
598
+ * **bucket**: GCS Bucket.
599
+ * **upload-dir**: GCS directory to upload to. Defaults to root directory.
600
+ * **local-dir**: Local directory to upload from. Can be set from a global perspective (~/travis/build) or relative perspective (build) Defaults to project root.
601
+ * **dot_match**: When set to `true`, upload files starting a `.`.
602
+ * **detect-encoding**: Set HTTP header `Content-Encoding` for files compressed with `gzip` and `compress` utilities. Defaults to not set.
603
+ * **cache_control**: Set HTTP header `Cache-Control` to suggest that the browser cache the file. Defaults to not set. Info is [here](https://developers.google.com/storage/docs/reference-headers#cachecontrol)
604
+ * **acl**: Sets the access control for the uploaded objects. Defaults to not set. Info is [here](https://developers.google.com/storage/docs/reference-headers#xgoogacl)
605
+
606
+ #### Examples:
607
+
608
+ dpl --provider=gcs --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket>
609
+ dpl --provider=gcs --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket> --local-dir= BUILD
610
+ dpl --provider=gcs --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket> --acl=public-read
611
+ dpl --provider=gcs --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket> --detect-encoding --cache_control=max-age=99999
612
+ dpl --provider=gcs --access-key-id=<access-key-id> --secret-access-key=<secret-access-key> --bucket=<bucket> --local-dir=BUILD --upload-dir=BUILDS
613
+
614
+ ### BitBalloon:
615
+
616
+ #### Options:
617
+
618
+ * **access_token**: Optional. The access_token which can be found in the `.bitballoon` file after a deployment using the bitballoon CLI. Only required if no `.bitballoon` file is present.
619
+ * **site_id**: Optional. The site_id which can be found in the .bitballoon file after a deployment using the bitballoon CLI. Only required if no `.bitballoon` file is present.
620
+ * **local_dir**: Optional. The sub-directory of the built assets for deployment. Default to current path.
621
+
622
+ #### Examples:
623
+
624
+ dpl --access-token=<access-token> --site-id=3f932c1e-708b-4573-938a-a07d9728c22e
625
+ dpl --access-token=<access-token> --site-id=3f932c1e-708b-4573-938a-a07d9728c22e --local-dir=build
626
+
627
+ ### Puppet Forge:
628
+
629
+ #### Options:
630
+
631
+ * **user**: Required. The user name at Puppet forge.
632
+ * **password**: Required. The Puppet forge password.
633
+ * **url**: Optional. The forge URL to deploy to. Defaults to https://forgeapi.puppetlabs.com/
634
+
635
+ #### Examples:
636
+
637
+ dpl --provider=puppetforge --user=puppetlabs --password=s3cr3t
638
+
639
+ ### packagecloud:
640
+
641
+ #### Options:
642
+
643
+ * **username**: Required. The packagecloud.io username.
644
+ * **token**: Required. The [packagecloud.io api token](https://packagecloud.io/docs/api#api_tokens).
645
+ * **repository**: Required. The repository to push to.
646
+ * **local_dir**: Optional. The sub-directory of the built assets for deployment. Default to current path.
647
+ * **dist**: Required for deb and rpm. The complete list of supported strings can be found on the [packagecloud.io docs](https://packagecloud.io/docs#os_distro_version)
648
+ * **force**: Optional. Wheter package has to be (re)uploaded / deleted before upload
649
+
650
+ #### Examples:
651
+
652
+ dpl --provider=packagecloud --username=packageuser --token=t0k3n --repository=myrepo
653
+ dpl --provider=packagecloud --username=packageuser --token=t0k3n --repository=myrepo --dist=ubuntu/precise
654
+ dpl --provider=packagecloud --username=packageuser --token=t0k3n --repository=myrepo --local-dir="${TRAVIS_BUILD_DIR}/pkgs" --dist=ubuntu/precise
655
+
656
+ ### Catalyze:
657
+
658
+ #### Options:
659
+
660
+ * **target**: Required. The git remote repository to deploy to.
661
+ * **path**: Optional. If using the skip_cleanup option to deploy from current file state, you can optionally specify the pathspec for the files to deploy. If not specified then all files are deployed.
662
+
663
+ #### Examples:
664
+
665
+ dpl --provider=catalyze --target=ssh://git@git.catalyzeapps.com:2222/app1234.git
666
+ dpl --provider=catalyze --target=ssh://git@git.catalyzeapps.com:2222/app1234.git --skip_cleanup=true
667
+ dpl --provider=catalyze --target=ssh://git@git.catalyzeapps.com:2222/app1234.git --skip_cleanup=true --path=build
668
+
669
+
670
+ #### Setup:
671
+
672
+ 1. Get the deployment target for Catalyze:
673
+ 1. Make sure your catalyze environment is [associated](https://resources.catalyze.io/paas/paas-cli-reference/#associate).
674
+ 2. Get the git remote by running ```git remote -v``` from within the associated repo.
675
+ 2. Setup a deployment key to Catalyze for Travis CI:
676
+ 1. Install the travis-ci cli.
677
+ 2. Get the public SSH key for your travis project and save it to a file by running ```travis pubkey > travis.pub```
678
+ 3. Add the key as a deploy key using the catalyze cli within the associated repo. For example: ```catalyze deploy-keys add travisci ./travis.pub code-1```
679
+ 3. Setup Catalyze as a known host for Travis CI:
680
+ 1. List your known hosts by running ```cat ~/.ssh/known_hosts```
681
+ 2. Find and copy the line from known_hosts that includes the git remote found in step #1. It'll look something like "[git.catalyzeapps.com]:2222 ecdsa-sha2-nistp256 BBBB12abZmKlLXNo..."
682
+ 3. Update your `before_deploy` step in `.travis.yml` to update the `known_hosts` file:
683
+
684
+ ```
685
+ before_deploy: echo "[git.catalyzeapps.com]:2222 ecdsa-sha2-nistp256 BBBB12abZmKlLXNo..." >> ~/.ssh/known_hosts
686
+ ```
687
+
688
+ ### Chef Supermarket:
689
+
690
+ #### Options:
691
+
692
+ * **user_id**: Required. The user name at Chef Supermarket.
693
+ * **client_key**: Required. The client API key file name.
694
+ * **cookbook_category**: Required. The cookbook category in Supermarket (see: https://docs.getchef.com/knife_cookbook_site.html#id12 )
695
+
696
+ #### Examples:
697
+
698
+ dpl --provider=chef-supermarket --user-id=chef --client-key=.travis/client.pem --cookbook-category=Others
699
+
700
+ ### Lambda:
701
+
702
+ #### Options:
703
+
704
+ * **access_key_id**: AWS Access Key ID. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
705
+ * **secret_access_key**: AWS Secret Key. Can be obtained from [here](https://console.aws.amazon.com/iam/home?#security_credential).
706
+ * **region**: AWS Region the Lambda function is running in. Defaults to 'us-east-1'.
707
+ * **function_name**: Required. The name of the Lambda being created / updated.
708
+ * **role**: Required. The ARN of the IAM role to assign to this Lambda function.
709
+ * **handler_name**: Required. The function that Lambda calls to begin execution. For NodeJS, it is exported function for the module.
710
+ * **module_name**: Optional. The name of the module that exports the handler. Defaults to `index`.
711
+ * **zip**: Optional. Either a path to an existing packaged (zipped) Lambda, a directory to package, or a single file to package. Defaults to `Dir.pwd`.
712
+ * **description**: Optional. The description of the Lambda being created / updated. Defaults to "Deploy build #{context.env['TRAVIS_BUILD_NUMBER']} to AWS Lambda via Travis CI"
713
+ * **timeout**: Optional. The function execution time at which Lambda should terminate the function. Defaults to 3 (seconds).
714
+ * **memory_size**: Optional. The amount of memory in MB to allocate to this Lambda. Defaults to 128.
715
+ * **runtime**: Optional. The Lambda runtime to use. Defaults to `node`.
716
+ * **publish**: If `true`, a [new version](http://docs.aws.amazon.com/lambda/latest/dg/versioning-intro.html#versioning-intro-publish-version) of the Lambda function will be created instead of replacing the code of the existing one.
717
+ * **subnet_ids**: Optional. List of subnet IDs to be added to the function. Needs the `ec2:DescribeSubnets` and `ec2:DescribeVpcs` permission for the user of the access/secret key to work.
718
+ * **security_group_ids**: Optional. List of security group IDs to be added to the function. Needs the `ec2:DescribeSecurityGroups` and `ec2:DescribeVpcs` permission for the user of the access/secret key to work.
719
+ * **dead_letter_arn**: Optional. ARN to an SNS or SQS resource used for the dead letter queue. [More about DLQs here](https://docs.aws.amazon
720
+ .com/lambda/latest/dg/dlq.html).
721
+ * **tracing_mode**: Optional. "Active" or "PassThrough" only. Default is "PassThrough". Needs the `xray:PutTraceSegments` and `xray:PutTelemetryRecords` on the role for this to work. [More on
722
+ Active Tracing here](https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html).
723
+ * **environment_variables**: Optional. List of Environment Variables to add to the function, needs to be in the format of `KEY=VALUE`. Can be encrypted for added security.
724
+ * **kms_key_arn**: Optional. KMS key ARN to use to encrypt `environment_variables`.
725
+ * **function_tags**: Optional. List of tags to add to the function, needs to be in the format of `KEY=VALUE`. Can be encrypted for added security.
726
+
727
+ For a list of all [permissions for Lambda, please refer to the documentation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html).
728
+
729
+ #### Examples:
730
+
731
+ Deploy contents of current working directory using default module:
732
+ ```
733
+ dpl --provider="lambda" \
734
+ --access_key_id="${AWS_ACCESS_KEY}" \
735
+ --secret_access_key="${AWS_SECRET_KEY}" \
736
+ --function_name="test-lambda" \
737
+ --role="${AWS_LAMBDA_ROLE}" \
738
+ --handler_name="handler";
739
+ ```
740
+ Deploy contents of a specific directory using specific module name:
741
+ ```
742
+ dpl --provider="lambda" \
743
+ --access_key_id="${AWS_ACCESS_KEY}" \
744
+ --secret_access_key="${AWS_SECRET_KEY}" \
745
+ --function_name="test-lambda" \
746
+ --role="${AWS_LAMBDA_ROLE}" \
747
+ --zip="${TRAVIS_BUILD_DIR}/dist" \
748
+ --module_name="copy" \
749
+ --handler_name="handler";
750
+ ```
751
+
752
+ ### Launchpad:
753
+
754
+ #### Options:
755
+
756
+ * **slug**: Required. `~user-name/project-name/branch-name`
757
+ * **oauth_token**: Required. Your OAUTH token for Launchpad
758
+ * **oauth_token_secret**: Required. Your OAUTH token secret for Launchpad
759
+
760
+ #### Example:
761
+
762
+ Deploy contents of current working directory using default module:
763
+ ```
764
+ dpl --provider="launchpad" \
765
+ --slug="~user-name/project-name/branch-name" \
766
+ --oauth_token="${LAUNCHPAD_OAUTH_TOKEN}" \
767
+ --oauth_token_secret="${LAUNCHPAD_OAUTH_TOKEN_SECRET}";
768
+ ```
769
+
770
+ ### TestFairy:
771
+
772
+ Your Android(apk)/iOS(ipa) file will be uploaded to TestFairy,
773
+ and your testers can start testing your app.
774
+
775
+ #### Options:
776
+ * **api-key**: TestFairy API Key (https://app.testfairy.com/settings/) run "travis encrypt --add deploy.api-key" on your repo.
777
+ * **app-file**: Path to the app file that will be generated after the build (APK/IPA).
778
+ * **symbols-file**: Path to the symbols file.
779
+ * **keystore-file**: Path to your keystore-file (must, only for android). http://docs.travis-ci.com/user/encrypting-files/
780
+ * **storepass**: storepass (must, only for android).
781
+ * **alias**: alias (must, only for android).
782
+ * **testers-groups**: You can set a tester group to be notified about this build (group1,group1).
783
+ * **notify**: If true, an email you a changelog will be sent to your users.
784
+ * **auto-update**: If true, all the previous installations of this app will be automatically all upgraded to this version.
785
+ * **video-quality**: Video quality settings, "high", "medium" or "low". Default is "high".
786
+ * **screenshot-interval**: You can choose "1"\"2"\"10" sec.
787
+ * **max-duration**: Maximum session recording length, eg "20m" or "1h". Default is "10m". Maximum "24h".
788
+ * **advanced-options**: For example (option1,option2)
789
+ * **data-only-wifi**: If true, video and recorded metrics will be sent only when connected to a wifi network.
790
+ * **record-on-background**: If true, data will be collected while the app on background.
791
+ * **video**: If true, Video recording settings "true", "false". Default is "true".
792
+ * **icon-watermark**: Add a small watermark to app icon. Default is "false".
793
+ * **metrics**: Comma-separated list of metrics to record. View list on http://docs.testfairy.com/Upload_API.html.
794
+
795
+ #### Examples:
796
+
797
+ dpl --provider=testfairy --api-key=<api-key> --app-file="out/Sample.apk" --keystore-file="out/keystore" --storepass=<storepass> --alias=<alias>
798
+
799
+ ### AWS CodeDeploy:
800
+
801
+ #### Options:
802
+
803
+ * **access-key-id**: AWS Access Key.
804
+ * **secret_access_key**: AWS Secret Access Key.
805
+ * **application**: CodeDeploy Application Name.
806
+ * **deployment_group**: CodeDeploy Deployment Group Name.
807
+ * **revision_type**: CodeDeploy Revision Type (S3 or GitHub).
808
+ * **commit_id**: Commit ID in case of GitHub.
809
+ * **repository**: Repository Name in case of GitHub.
810
+ * **region**: AWS Availability Zone.
811
+ * **wait-until-deployed**: Wait until the app is deployed and return the deployment status (Optional, Default false).
812
+
813
+ #### Environment variables:
814
+
815
+ * **AWS_ACCESS_KEY_ID**: AWS Access Key ID. Used if the `access-key-id` option is omitted.
816
+ * **AWS_SECRET_ACCESS_KEY**: AWS Secret Key. Used if the `secret-access-key` option is omitted.
817
+
818
+ #### Examples:
819
+
820
+ dpl --provider=codedeploy --access-key-id=<aws access key> --secret_access_key=<aws secret access key> --application=<application name> --deployment_group=<deployment group> --revision_type=<s3/github> --commit_id=<commit ID> --repository=<repo name> --region=<AWS availability zone> --wait-until-deployed=<true>
821
+
822
+ ### Scalingo:
823
+
824
+ #### Options:
825
+ * **api_key**: scalingo API Key. Not necessary if username and password are used.
826
+ * **username**: scalingo username. Not necessary if api_key is used.
827
+ * **password**: scalingo password. Not necessary if api_key is used.
828
+ * **remote**: Remote url or git remote name of your git repository. By default remote name is "scalingo".
829
+ * **branch**: Branch of your git repository. By default branch name is "master".
830
+ * **app**: Only necessary if your repository does not contain the appropriate remote. Specifying the app will add a remote to your local repository: `git remote add <remote> git@scalingo.com:<app>.git`
831
+
832
+ #### Use:
833
+
834
+ You can connect to Scalingo using your username/password or your api key.
835
+ It needs [Scalingo CLI](http://cli.scalingo.com/) which will be [downloaded here](http://cli.scalingo.com/).
836
+ Then, it will push your project to Scalingo and deploy it automatically.
837
+
838
+ Note: You only need to connect once to Scalingo CLI, credentials are stored locally.
839
+
840
+ #### Examples:
841
+
842
+ dpl --provider=scalingo --api_key="aaAAbbBB0011223344"
843
+ dpl --provider=scalingo --username=<username> --password=<password>
844
+
845
+ dpl --provider=scalingo --api_key="aaAAbbBB0011223344" --remote="scalingo-staging"
846
+ dpl --provider=scalingo --api_key="aaAAbbBB0011223344" --remote="scalingo-staging" --branch="master"
847
+
848
+ dpl --provider=scalingo
849
+
850
+ ### Script:
851
+
852
+ An elementary provider that executes a single command.
853
+
854
+ Deployment will be marked a failure if the script exits with nonzero status.
855
+
856
+ #### Option:
857
+
858
+ * **script**: script to execute.
859
+
860
+ #### Example:
861
+
862
+ dpl --provider=script --script=./script/deploy.sh
863
+
864
+ ### Google App Engine:
865
+
866
+ Deploys to Google App Engine and Google App Engine Managed VMs via the Google Cloud SDK and
867
+ it's [`gcloud` tool](https://cloud.google.com/sdk/gcloud/) using a [Service Account](https://developers.google.com/console/help/new/#serviceaccounts).
868
+ In order to use this provider, please make sure you have the [App Engine Admin API](https://developers.google.com/apis-explorer/#p/appengine/v1beta4/) enabled [in the Google Developers Console](https://console.developers.google.com/project/_/apiui/apiview/appengine/overview).
869
+
870
+ #### Options:
871
+
872
+ * **project**: [Project ID](https://developers.google.com/console/help/new/#projectnumber) used to identify the project on Google Cloud.
873
+ * **keyfile**: Path to the JSON file containing your [Service Account](https://developers.google.com/console/help/new/#serviceaccounts) credentials in [JSON Web Token](https://tools.ietf.org/html/rfc7519) format. To be obtained via the [Google Developers Console](https://console.developers.google.com/project/_/apiui/credential). Defaults to `"service-account.json"`. Note that this file should be handled with care as it contains authorization keys.
874
+ * **config**: Path to your module configuration file. Defaults to `"app.yaml"`. This file is runtime dependent ([Go](https://cloud.google.com/appengine/docs/go/config/appconfig), [Java](https://cloud.google.com/appengine/docs/java/configyaml/appconfig_yaml), [PHP](https://developers.google.com/console/help/new/#projectnumber), [Python](https://cloud.google.com/appengine/docs/python/config/appconfig))
875
+ * **version**: The version of the app that will be created or replaced by this deployment. If you do not specify a version, one will be generated for you. See [`gcloud preview app deploy`](https://cloud.google.com/sdk/gcloud/reference/preview/app/deploy)
876
+ * **no_promote**: Flag to not promote the deployed version. See [`gcloud preview app deploy`](https://cloud.google.com/sdk/gcloud/reference/preview/app/deploy)
877
+ * **verbosity**: Let's you adjust the verbosity when invoking `"gcloud"`. Defaults to `"warning"`. See [`gcloud`](https://cloud.google.com/sdk/gcloud/reference/).
878
+ * **no_stop_previous_version**: Flag to prevent your deployment from stopping the previously promoted version. This is from the future, so might not work (yet). See [`gcloud preview app deploy`](https://cloud.google.com/sdk/gcloud/reference/preview/app/deploy)
879
+
880
+ #### Environment variables:
881
+
882
+ * **GOOGLECLOUDPROJECT** or **CLOUDSDK_CORE_PROJECT**: Can be used instead of the `project` option.
883
+ * **GOOGLECLOUDKEYFILE**: Can be used instead of the `keyfile` option.
884
+
885
+ #### Example:
886
+
887
+ dpl --provider=gae --project=example --no_promote=true
888
+
889
+ ### Firebase:
890
+
891
+ #### Options:
892
+
893
+ * **token**: Your Firebase CI access token (generate with `firebase login:ci`)
894
+ * **project**: Deploy to a different Firebase project than specified in your `firebase.json` (e.g. `myapp-staging`)
895
+ * **message**: Optional. The message describing this deploy.
896
+
897
+ #### Examples:
898
+
899
+ dpl --provider=firebase --token=<token> --project=<project> --message=<message>
900
+
901
+
902
+
903
+ ### Surge.sh
904
+
905
+ #### Options:
906
+
907
+ * **project** Path to project folder relative to repo root. Defaults to repo root if not set.
908
+ * **domain** Domain to publish to. Can be omitted if domain is set in the `CNAME` file in the project folder.
909
+
910
+
911
+ #### Environment variables:
912
+
913
+ * **SURGE_LOGIN**: Set it to the email address you use with Surge
914
+ * **SURGE_TOKEN**: Set it to your login token (get it by doing a `surge token`)
915
+
916
+ #### Example:
917
+ dpl --provider=surge --project=<project-path> --domain=<domain-name>
918
+
919
+ ### Bluemix Cloud Foundry:
920
+
921
+ #### Options:
922
+
923
+ * **username**: Bluemix username.
924
+ * **password**: Bluemix password.
925
+ * **organization**: Bluemix target organization.
926
+ * **space**: Bluemix target space
927
+ * **region**: Bluemix region [ng, eu-gb, eu-de, au-syd]. Optional, default US region (ng).
928
+ * **api**: Bluemix api URL. Optional for Bluemix dedicated. Explicit **api** setting precedence over **region** setting.
929
+ * **manifest**: Path to manifest file. Optional.
930
+ * **skip_ssl_validation**: Skip ssl validation. Optional.
931
+
932
+ #### Examples:
933
+
934
+ dpl --provider=bluemixcloudfoundry --username=<username> --password=<password> --organization=<organization> --region=<region> --space=<space> --skip-ssl-validation