Merge pull request #5 from K-and-R/optional-repo-integration

Additional optional config and optional repo integration

Author: burisu

README.md

@@ -56,6 +56,14 @@ after 'deploy:published', 'sentry:notice_deployment'
 
 * `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 `[email protected]:codeur/capistrano-sentry.git` becomes `codeur/capistrano-sentry`]
 
+* `sentry_repo_integration`: this enables/disables submission of git repo information (`release_refs` below) to Sentry [Enabled (`true`) by default].
+
+* `sentry_release_refs`: Repository details about this realease (`repository`, `commit`, `previousCommit`) to Sentry [computed from `sentry_repo`, `current_revision`, and `previous_revision`)].
+
+* `sentry_release_version`: Version number (tag, etc.) used to identify this release to Sentry [computed from `current_revision` or repository `HEAD`)].
+
+* `deploy_name`: A name (revision, version number, tag, etc.) used to identify this release deploy to Sentry [computed from `sentry_release_version`+`fetch(:release_timestamp)`)].
+
 ### 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/)

capistrano-sentry.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Capistrano::Sentry::VERSION
   spec.authors       = ['Brice Texier']
   spec.email         = ['[email protected]']
-
+  spec.description   = 'Sentry release/deployment integration'
   spec.summary       = 'Sentry release/deployment integration'
   spec.homepage      = 'https://github.com/codeur/capistrano-sentry'
   spec.license       = 'MIT'

lib/capistrano/tasks/sentry.rake

@@ -33,44 +33,50 @@ namespace :sentry do
       require 'net/https'
       require 'json'
 
-      version = `git rev-parse HEAD`.strip
+      head_revision = fetch(:current_revision) || `git rev-parse HEAD`.strip
+      prev_revision = fetch(:previous_revision) || `git rev-parse #{fetch(:current_revision)}^`.strip
 
       sentry_host = ENV['SENTRY_HOST'] || fetch(:sentry_host, 'https://sentry.io')
-      orga_slug = fetch(:sentry_organization) || fetch(:application)
+      organization_slug = fetch(:sentry_organization) || fetch(:application)
       project = fetch(:sentry_project) || fetch(:application)
       environment = fetch(:stage) || 'default'
       api_token = ENV['SENTRY_API_TOKEN'] || fetch(:sentry_api_token)
-      repo_name = fetch(:sentry_repo) || fetch(:repo_url).split(':').last.gsub(/\.git$/, '')
+      repo_integration_enabled = fetch(:sentry_repo_integration, true)
+      release_refs = fetch(:sentry_release_refs, [{
+        repository: fetch(:sentry_repo) || fetch(:repo_url).split(':').last.gsub(/\.git$/, ''),
+        commit: head_revision,
+        previousCommit: prev_revision,
+      }])
+      release_version = fetch(:sentry_release_version) || head_revision
+      deploy_name = fetch(:sentry_deploy_name) || "#{release_version}-#{fetch(:release_timestamp)}"
 
       uri = URI.parse(sentry_host)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
 
       headers = {
         'Content-Type' => 'application/json',
-        'Authorization' => 'Bearer ' + api_token.to_s
+        'Authorization' => 'Bearer ' + api_token.to_s,
       }
 
-      req = Net::HTTP::Post.new("/api/0/organizations/#{orga_slug}/releases/", headers)
-      req.body = JSON.generate(
-        version: version,
-        refs: [{
-          repository: repo_name,
-          commit: fetch(:current_revision) || `git rev-parse HEAD`.strip
-        }],
-        projects: [project]
-      )
+      req = Net::HTTP::Post.new("/api/0/organizations/#{organization_slug}/releases/", headers)
+      body = {
+        version: release_version,
+        projects: [project],
+      }
+      body[:refs] = release_refs if repo_integration_enabled
+      req.body = JSON.generate(body)
       response = http.request(req)
       if response.is_a? Net::HTTPSuccess
-        info 'Uploaded release infos to Sentry'
-        req = Net::HTTP::Post.new("/api/0/organizations/#{orga_slug}/releases/#{version}/deploys/", headers)
+        info "Notified Sentry of new release: #{release_version}"
+        req = Net::HTTP::Post.new("/api/0/organizations/#{organization_slug}/releases/#{release_version}/deploys/", headers)
         req.body = JSON.generate(
           environment: environment,
-          name: "#{version}-#{fetch(:release_timestamp)}"
+          name: deploy_name,
         )
         response = http.request(req)
         if response.is_a? Net::HTTPSuccess
-          info 'Uploaded deployment infos to Sentry'
+          info "Notified Sentry of new deployment: #{deploy_name}"
         else
           warn "Cannot notify sentry for new deployment. Response: #{response.code.inspect}: #{response.body}"
         end