capistrano-sentry 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2b0c32362fb64aaaa1e3037835ddf4e8c57db855e4081f3be2777ed78c5082
-  data.tar.gz: 38c19a019f359db6dd0f12d6b9c17faa5a4d4c3e2d8137b1765a928e8a6155b7
+  metadata.gz: eb193cb50eb3f8ecfd39146451c570de4536f8ff22a86aef6663bdd290db0814
+  data.tar.gz: 34316e7f275118450ae34fd9722b6d2f050f0849bb92cec062816bcc0e0c74e4
 SHA512:
-  metadata.gz: b3ea7744d925f10e7930cae9c6793f2303cd34be0ac5821880462345f46fe10e90a94400987259b1c591e2f63440424ee8257ce162cf7c1998191b992157d4af
-  data.tar.gz: ecdec189a6ae9f5848171738c48bad136e381994ec3d99d1460a9827af5cb746290aec9eaca6c430a16024b8a1da62d5c16711cb8f20c2316e2df63e35d9853a
+  metadata.gz: daedfea3dfadbb1b6395bf73c0f4f4b11a3a417c33d77e30e79f0bb7034d010c027a1f0126e4161a355dc3e4475f64f7313606a33408b84706cad1a76eae3de3
+  data.tar.gz: 016b032dc21bc1276389eb3dfda706246d09106da1913d5384980ecf245c41184132ba09e31d6855822e59650c9789dddea62f29afd845341bca7b8dd7335768

data/.gitignore

@@ -6,4 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-*~
+Gemfile.lock
+*~

data/README.md

@@ -2,15 +2,12 @@
 
 Simple extension of capistrano for automatic notification of Sentry.
 
-TODO: Prevent user at deployment start if missing parameter to inform sentry
-      properly
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'capistrano-sentry'
+gem 'capistrano-sentry', require: false
 ```
 
 Then, add this line to your application's Capfile:
@@ -32,14 +29,37 @@ Add these lines to your application's `config/deploy.rb`:
 ```ruby
 # Sentry deployment notification
 set :sentry_host, 'https://my-sentry.mycorp.com' # https://sentry.io by default
-set :sentry_api_token, 'd9fe44a1cf34e63993e258dbecf42158918d407978a1bb72f8fb5886aa5f9fe1'
+set :sentry_api_token, '0123456789abcdef0123456789abcdef'
 set :sentry_organization, 'my-org' # fetch(:application) by default
 set :sentry_project, 'my-proj'     # fetch(:application) by default
 set :sentry_repo, 'my-org/my-proj' # computed from repo_url by default
+```
 
+If you want deployments to be published in every Rails environment, put this in `config/deploy.rb`, otherwise put it your environment-specific deploy file (i.e. `config/deploy/production.rb`):
+```ruby
+before 'deploy:starting', 'sentry:validate_config'
 after 'deploy:published', 'sentry:notice_deployment'
 ```
 
+### Explaination of Configuration Properties
+
+* `sentry_host`: identifies to which host Sentry submissions are sent. [https://sentry.io by default]
+
+* `sentry_api_token`: API Auth Tokens are found/created in you Sentry Account Settings (not in the organization or project): `Settings > Account > Api > Auth Tokens`.
+ [https://sentry.io/settings/account/api/auth-tokens/]
+
+* `sentry_organization`: The "**Name**" ("*A unique ID used to identify this organization*") from Sentry's Organization Settings page.
+[https://sentry.io/settings/{ORGANIZATION_SLUG}]
+
+* `sentry_project`: The "**Name**" ("*A unique ID used to identify this project*") from Sentry's Project Settings page.
+[https://sentry.io/settings/{ORGANIZATION_SLUG}/projects/{PROJECT_SLUG}]
+
+* `sentry_repo`: The `repository` name to be used when reporting repository details to Sentry [computed from `fetch(:repo_url)` by default -- `https://github.com/codeur/capistrano-sentry` becomes `//github.com/codeur/capistrano-sentry` and `git@github.com:codeur/capistrano-sentry.git` becomes `codeur/capistrano-sentry`]
+
+### Sentry API Documentation
+* [Project Releases](https://docs.sentry.io/api/releases/post-project-releases/)
+* [Release Deploys](https://docs.sentry.io/api/releases/post-release-deploys/)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/capistrano/sentry/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Sentry
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/capistrano/tasks/sentry.rake

@@ -1,12 +1,31 @@
-# This task will notify Sentry via their API[1] that you have deployed
+# This task will notify Sentry via their API[1][2] that you have deployed
 # a new release. It uses the commit hash as the `version` and the git ref as
 # the optional `ref` value.
 #
-# [1]: https://docs.getsentry.com/hosted/api/releases/post-project-releases
+# [1]: https://docs.sentry.io/api/releases/post-project-releases/
+# [2]: https://docs.sentry.io/api/releases/post-release-deploys/
 
 # For Rails app, this goes in config/deploy.rb
 
+module Capistrano
+  class SentryConfigurationError < StandardError
+  end
+end
+
 namespace :sentry do
+  desc 'Confirm configuration for notification to Sentry'
+  task :validate_config do
+    run_locally do
+      info '[sentry:validate_config] Validating Sentry notification config'
+      api_token = ENV['SENTRY_API_TOKEN'] || fetch(:sentry_api_token)
+      if api_token.nil? || api_token.empty?
+        msg = "Missing SENTRY_API_TOKEN. Please set SENTRY_API_TOKEN environment variable or `set :sentry_api_token` in your `config/deploy.rb` file for your Rails application."
+        warn msg
+        fail Capistrano::SentryConfigurationError, msg
+      end
+    end
+  end
+
   desc 'Notice new deployment in Sentry'
   task :notice_deployment do
     run_locally do
@@ -61,8 +80,3 @@ namespace :sentry do
     end
   end
 end
-
-# If you want deployments to be published in every Rails environment, put this
-# in config/deploy.rb, otherwise put it your environment-specific deploy file
-# i.e. config/deploy/production.rb
-# after 'deploy:published', 'sentry:notice_deployment'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sentry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brice Texier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano