paratrooper 1.1.0 → 1.1.1
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +27 -18
- data/lib/paratrooper/default_formatter.rb +1 -1
- data/lib/paratrooper/version.rb +1 -1
- metadata +2 -2
data/README.md
CHANGED
@@ -4,41 +4,47 @@
|
|
4
4
|
[![Build Status](https://travis-ci.org/mattpolito/paratrooper.png?branch=master)](https://travis-ci.org/mattpolito/paratrooper)
|
5
5
|
[![Code Climate](https://codeclimate.com/github/mattpolito/paratrooper.png)](https://codeclimate.com/github/mattpolito/paratrooper)
|
6
6
|
|
7
|
-
|
7
|
+
Simplify your [Heroku][] deploy with quick and concise deployment rake tasks.
|
8
8
|
|
9
9
|
## Installation
|
10
10
|
|
11
11
|
Add this line to your application's Gemfile:
|
12
12
|
|
13
|
-
|
13
|
+
```shell
|
14
|
+
gem 'paratrooper'
|
15
|
+
```
|
16
|
+
|
17
|
+
and then execute
|
14
18
|
|
15
|
-
|
19
|
+
```shell
|
20
|
+
bundle
|
21
|
+
```
|
16
22
|
|
17
|
-
|
23
|
+
or
|
18
24
|
|
19
|
-
|
25
|
+
install it yourself with
|
20
26
|
|
21
|
-
|
27
|
+
```shell
|
28
|
+
gem install paratrooper
|
29
|
+
```
|
22
30
|
|
23
31
|
## Usage
|
24
32
|
|
25
|
-
Instantiate Paratrooper with the name of your heroku application
|
33
|
+
Instantiate Paratrooper with the name of your heroku application.
|
26
34
|
|
27
35
|
```ruby
|
28
36
|
Paratrooper::Deploy.new('amazing-app')
|
29
37
|
```
|
30
38
|
|
31
|
-
|
39
|
+
You can also provide a tag:
|
32
40
|
|
33
41
|
```ruby
|
34
42
|
Paratrooper::Deploy.new('amazing-app', tag: 'staging')
|
35
43
|
```
|
36
44
|
|
37
|
-
Then there are methods available to perform common tasks like creating git tags, running migrations, and warming your application instance.
|
38
|
-
|
39
45
|
## Authentication
|
40
46
|
|
41
|
-
|
47
|
+
You can authenticate your Heroku account in a few different ways:
|
42
48
|
|
43
49
|
* Providing API Key
|
44
50
|
|
@@ -46,20 +52,21 @@ Authentication with your Heroku account can happen in a few different ways
|
|
46
52
|
Paratrooper::Deploy.new('app', api_key: 'API_KEY')
|
47
53
|
```
|
48
54
|
|
49
|
-
*
|
55
|
+
* Setting an environment variable
|
50
56
|
|
51
57
|
```ruby
|
52
58
|
ENV['HEROKU_API_KEY'] = 'API_KEY'
|
53
59
|
Paratrooper::Deploy.new('app')
|
54
60
|
```
|
55
61
|
|
56
|
-
* Local file
|
57
|
-
This method works via a local Netrc file. Storage of this key is handled via the [Heroku Toolbelt][]. This is the default and preferred method of providing your authentication key.
|
62
|
+
* Local Netrc file
|
58
63
|
|
59
64
|
```ruby
|
60
65
|
Paratrooper::Deploy.new('app')
|
61
66
|
```
|
62
67
|
|
68
|
+
This method works via a local Netrc file which is handled via the [Heroku Toolbelt][] and is the default and preferred method of providing your authentication key.
|
69
|
+
|
63
70
|
## Tag Management
|
64
71
|
|
65
72
|
By providing tag options into Paratrooper, your code can be tagged and deployed from different reference points.
|
@@ -83,7 +90,7 @@ This will create/update a `production` git tag at `staging` and deploys the `pro
|
|
83
90
|
|
84
91
|
## Sensible Default Deployment
|
85
92
|
|
86
|
-
You can use the objects methods any way you'd like but we've provided a sensible default at `Paratrooper#deploy`
|
93
|
+
You can use the objects methods any way you'd like, but we've provided a sensible default at `Paratrooper#deploy`
|
87
94
|
|
88
95
|
This will perform the following tasks:
|
89
96
|
|
@@ -96,6 +103,7 @@ This will perform the following tasks:
|
|
96
103
|
* Warm application instance
|
97
104
|
|
98
105
|
### Example Usage
|
106
|
+
|
99
107
|
```ruby
|
100
108
|
require 'paratrooper'
|
101
109
|
|
@@ -123,11 +131,12 @@ end
|
|
123
131
|
|
124
132
|
## Bucking the Norm
|
125
133
|
|
126
|
-
Our default deploy gets us most of the way but maybe it's not for you. We've got you covered.
|
134
|
+
Our default deploy gets us most of the way, but maybe it's not for you. We've got you covered. Every instance of Paratrooper will have access to all of the included methods so you can build your custom deploy.
|
127
135
|
|
128
|
-
|
136
|
+
For example, say you want to let [New Relic][] know that you are deploying and to disable your heartbeart.
|
129
137
|
|
130
138
|
### Example Usage
|
139
|
+
|
131
140
|
```ruby
|
132
141
|
require 'paratrooper'
|
133
142
|
|
@@ -156,7 +165,7 @@ end
|
|
156
165
|
|
157
166
|
## Nice to haves
|
158
167
|
|
159
|
-
*
|
168
|
+
* Send [New Relic][] a notification to toggle heartbeat during deploy
|
160
169
|
|
161
170
|
## Contributing
|
162
171
|
|
data/lib/paratrooper/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: paratrooper
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.1.
|
4
|
+
version: 1.1.1
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -10,7 +10,7 @@ authors:
|
|
10
10
|
autorequire:
|
11
11
|
bindir: bin
|
12
12
|
cert_chain: []
|
13
|
-
date: 2013-02-
|
13
|
+
date: 2013-02-11 00:00:00.000000000 Z
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: rake
|