mina-rollbar 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 237a557f5b0940298124e80da63462761aac6c0d
4
- data.tar.gz: 53f2f9a694be31daca01fbaec9dc262840a9a89e
3
+ metadata.gz: c8816a068b6fd5712217e3efa0e900a4c05cc701
4
+ data.tar.gz: d85d719283d7f3d1ba1421599b7b664268bfc387
5
5
  SHA512:
6
- metadata.gz: 7bebdd009ddb1b271379788a78f6a9ee8614aca91a27fe559e48eccde8ad0ec7458e7d117c5d7084a1b03c7c66e581140153063cd95e7832da2b5f9e9d51e884
7
- data.tar.gz: 788577260b59705f4796e298495cc7171fd08b9d46fc811646f0454fd26832a5c2842a1b8aa7a575bd5160868a9f5d5595388d765e959e53461d4179baed8f44
6
+ metadata.gz: 4078f947852c534b75955ee9bd0a0214147c876cd7f2aca0bd49ac2c6e8b039dde13962a5f45a6e15118ec62dd213506dc80974e868750589365fc91ecffbbde
7
+ data.tar.gz: 28419ffacf6fa56088abd82e783ad138816da8482fcf3ea8db766d14f26af533bc4cb31f524f95621766c6d73c354d723143cd0779d9c429217d1170fb74dc9b
data/README.md CHANGED
@@ -2,29 +2,55 @@
2
2
 
3
3
  [Mina](https://github.com/mina-deploy/mina) tasks for interacting with [Rollbar.io](http://rollbar.io).
4
4
 
5
+ Adds the following tasks:
6
+
7
+ rollbar:notify
8
+
5
9
  ## Installation
6
10
 
7
11
  Add this line to your application's Gemfile:
8
12
 
9
13
  ```ruby
10
- gem 'mina-rollbar'
14
+ gem 'mina-rollbar', require: false
11
15
  ```
12
16
 
13
17
  And then execute:
14
18
 
15
19
  $ bundle
16
20
 
17
- Or install it yourself as:
21
+ ## Usage
18
22
 
19
- $ gem install mina-rollbar
23
+ **Note:** Currently requires `curl` to be present on the server for notifications to be sent. Patches happily accepted to improve this limitation!
20
24
 
21
- ## Usage
25
+ require 'mina/rollbar'
26
+
27
+ ...
28
+ set :rollbar_access_token, '9a18d718214b4348822b7cec493f86d2'
29
+
30
+ task deploy: :environment do
31
+ deploy do
32
+ ...
33
+
34
+ to :launch do
35
+ ...
36
+ invoke :'rollbar:notify'
37
+ end
38
+ end
39
+ end
40
+
41
+ ## Options
22
42
 
23
- TODO: Write usage instructions here
43
+ | Name | Description |
44
+ | ---------------------------- | -------------------------------------------------- |
45
+ | `rollbar_access_token` | Rollbar.io access token (post_server_item token) |
46
+ | `rollbar_username` | Rollbar.io username of deploying user (optional) |
47
+ | `rollbar_local_username` | Local username of deploying user (optional) |
48
+ | `rollbar_comment` | Comment for this deployment (optional) |
49
+ | `rollbar_notification_debug` | `true` to enable notification debugging info |
24
50
 
25
51
  ## Contributing
26
52
 
27
- 1. Fork it ( https://github.com/[my-github-username]/mina-rollbar/fork )
53
+ 1. Fork it ( https://github.com/code-lever/mina-rollbar/fork )
28
54
  2. Create your feature branch (`git checkout -b my-new-feature`)
29
55
  3. Commit your changes (`git commit -am 'Add some feature'`)
30
56
  4. Push to the branch (`git push origin my-new-feature`)
@@ -29,12 +29,20 @@ require 'mina/rails'
29
29
  # Sets the access token for your Rollbar account. Required.
30
30
  set_default :rollbar_access_token, nil
31
31
 
32
+ # ### rollbar_username
33
+ # Sets the Rollbar.io username of the user who deployed. Optional.
32
34
  set_default :rollbar_username, nil
33
35
 
34
- set_default :rollbar_local_username, nil
36
+ # ### rollbar_local_username
37
+ # Sets the name of the user who deployed. Defaults to `whoami`. Optional.
38
+ set_default :rollbar_local_username, %x[whoami] rescue nil
35
39
 
40
+ # ### rollbar_comment
41
+ # Sets a deployment comment (what was deployed, etc.). Optional.
36
42
  set_default :rollbar_comment, nil
37
43
 
44
+ # ### rollbar_notification_debug
45
+ # If true, enables verbosity in the notification to help debug issues. Defaults to false.
38
46
  set_default :rollbar_notification_debug, false
39
47
 
40
48
  namespace :rollbar do
@@ -1,5 +1,5 @@
1
1
  module Mina
2
2
  module Rollbar
3
- VERSION = '0.1.0'
3
+ VERSION = '0.1.1'
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mina-rollbar
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nick Veys