circleci_deployment_notifier 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d33310b4336ae0ac91b9649691dbeaf7070569fe
-  data.tar.gz: 4714fc08c4a00f01c33091d366975608687b27e9
+  metadata.gz: 623ab579691418aeeddac43ad98528a7b10eb6f8
+  data.tar.gz: 76eb2e378db4c6ed18e50aed82c4270714e71e1b
 SHA512:
-  metadata.gz: 1818a8cdb6e29cd6d81a79fce46352bf208370e9a7619812599c27cf71bd4a36c089e42a508c9eb45916565cb6ef24a23c137cd6f0dd1e83d18e8fae5681715d
-  data.tar.gz: 50969eaeef8bc73658c2d212addec59381f256e71ff00a0b493d2b9f10c03e02f8b0b54cf52979d5fa524e39eb9e768895cb32759f73d835683347692f69cece
+  metadata.gz: 37ad34ed733bdf8847e2fbfc513af88ba72776a90a4e20538f7083f4ef549ef6a07af85c2886f1a210e2f34a4be3745184e5200d62e6e0e122ed453bae5fd327
+  data.tar.gz: f8fb9fec57cff128db9b329be4e59545075e08045978f7828200c5d212353cf4c2981a7b179409bb6141ea4d116b050a0e1815204d0cddc53b61014f6554f2f7

data/README.md

@@ -7,11 +7,15 @@
 
 Sends deployment notifications based on deployments that occur on CircleCI.
 
+![Deployment notifications on Slack](./images/slack-deployment-notifications.png)
+
+![Deployment indications on New Relic](./images/new-relic-deployments.png)
+
 Assumptions:
 
 - Using CircleCI.
 - Using Github.
-- Using Slack for notifications.
+- Using Slack for notifications and/or using New Relic.
 
 You can also:
 
@@ -26,12 +30,13 @@ Add the following commands to your `circle.yml` deployment section:
 ```sh
 gem install circleci_deployment_notifier
 circleci_deployment_notify_slack -a "Application Name" -u "https://hooks.slack.com/services/WEBHOOK"
+circleci_deployment_notify_new_relic -a "Application Name" --api-key "12345abcde" --app-id "12345678"
 ```
 
-It's best to use environment variables for sensitive information list Slack webhook URLs.
+It's best to use environment variables for sensitive information such as Slack webhook URLs or API keys.
 
 So here's an example `circle.yml` deployment section that 
-assumes you've set the environment variable `DEPLOYMENT_SLACK_WEBHOOK_URL`:
+assumes you've set the environment variables `DEPLOYMENT_SLACK_WEBHOOK_URL` and `NEW_RELIC_API_KEY`:
 ```yml
 deployment:
   staging:
@@ -40,6 +45,7 @@ deployment:
     - # TODO: something to deploy the application to staging
     - gem install circleci_deployment_notifier
     - circleci_deployment_notify_slack -a "Application Staging" -u $DEPLOYMENT_SLACK_WEBHOOK_URL
+    - circleci_deployment_notify_new_relic -a "Application Staging" --api-key $NEW_RELIC_API_KEY --app-id "12345678"
   production:
     tag: /v[0-9]+\.[0-9]+\.[0-9]+/
     owner: MyOrganization
@@ -47,13 +53,31 @@ deployment:
     - # TODO: something to deploy the application to production
     - gem install circleci_deployment_notifier
     - circleci_deployment_notify_slack -a "Application Production" -u $DEPLOYMENT_SLACK_WEBHOOK_URL
+    - circleci_deployment_notify_new_relic -a "Application Production" --api-key $NEW_RELIC_API_KEY --app-id "87654321"
 ```
 
+### Tag Deploys
 That `production` section is designed to build and deploy for tags like "v1.0.0" that are created in
 the fork of the repo that belongs to MyOrganization.
 (So tags created in forks do not cause a build or deployment.)
 See [CircleCI docs](https://circleci.com/docs/configuration/#tags) for more info.
 
+### Slack Webhook
+
+Create an Incoming Webhook service in Slack, and assign it the channel you want it to post.
+If you want to post staging and production notifications to different Slack channels, you will need
+to create different Webhooks for each.
+
+### New Relic
+
+To get the New Relic App ID for each application, you must first have the application running and
+reporting to New Relic.
+This creates the application in New Relic and it will appear in the APM area of
+[rpm.newrelic.com](https://rpm.newrelic.com).
+
+Find the application in New Relic, and get the App ID from its URL.
+The URL will look like `https://rpm.newrelic.com/accounts/<your_account_number>/applications/<app_id>`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/circleci_deployment_notifier.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '~> 2.1'
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/circleci_deployment_notifier/build_info.rb

@@ -48,7 +48,9 @@ module CircleciDeploymentNotifier
     end
 
     def repository_url
-      ENV['CIRCLE_REPOSITORY_URL']
+      ENV['CIRCLE_REPOSITORY_URL'].sub(/\Agit@([-\.a-z]+):(.+)\.git\z/) { |m|
+        "https://#{$1}/#{$2}"
+      }
     end
 
     def build_identifier

data/lib/circleci_deployment_notifier/version.rb

@@ -1,3 +1,3 @@
 module CircleciDeploymentNotifier
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci_deployment_notifier
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Robin Daugherty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-15 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,8 @@ files:
 - circleci_deployment_notifier.gemspec
 - exe/circleci_deployment_notify_new_relic
 - exe/circleci_deployment_notify_slack
+- images/new-relic-deployments.png
+- images/slack-deployment-notifications.png
 - lib/circleci_deployment_notifier.rb
 - lib/circleci_deployment_notifier/build.rb
 - lib/circleci_deployment_notifier/build_info.rb
@@ -146,9 +148,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Sends deployment notifications based on deployments that occur on CircleCI.