heroku_tool 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3976746c758a9c07bdab1899d92ba5c7bcdcbb46b819c64f465bba638549f3d
-  data.tar.gz: 3b148a6088fd1213cab9073f3439ca1a1d238db40c16d9760f45ab0d81e31654
+  metadata.gz: 5aff0c40aebac826f0c564531114ce61762c7e1fed7ad87b281160c7b27bccd0
+  data.tar.gz: b8ff4953f2f385b49f7a25a8f276bdce0e5221f34db9a5207b3f60fb3ebe1c63
 SHA512:
-  metadata.gz: '094f8d6257f12c9d74680aa8191f3f24f3c0af29d9dc43ddbe1ba022451c55792b3583c188d5a5f3cb19985aa18036eb918d3a46feb3a163f75a7b8ba03ba264'
-  data.tar.gz: 3a0e29e85f0d2b87880f741750a0e254eb6d7e1106af0c762c1fce495deea0c2870b55ddedf671d4a767d24f79d821e3850123818b23ffe23770bfebe42057b3
+  metadata.gz: 7275494d3fbd74ac696cd30394b8a7969594c6c77e2ad9aac787a1562247956a3b28de99940a6f085da2b55d99337a3a207c66b441710c0f50c2328d92055783
+  data.tar.gz: 8a49007bd74cd1b5cedf559e3d7ad0afaae2765eef98d9c25b2003e04afedb7c422052f168d2fc6e3fb4ec090beb28583fc05719c785703230a18764b9d2f9fe

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.9.3
+
+record the app revision using git describe, at the beginning of the process (in case of accidental branch switches)
+
+## v0.9.2
+
+update and fix bugsnag deploy tracking
+
 ## v0.9.1
 
 support url in heroku targets

data/lib/heroku_tool/commander.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "open3"
+require "shellwords"
+
 module HerokuTool
   class Commander
     # @return [HerokuTool::HerokuTargets::HerokuTarget]
@@ -12,13 +15,21 @@ module HerokuTool
       @configuration = configuration
     end
 
+    # The deploy ref is resolved to a commit once, before anything else happens, and that commit is what gets
+    # described, pushed and recorded: checking out another branch (or fetching) while the deploy is running
+    # doesn't change what is deployed or how it is reported.
+    #
+    # @return [String, false] the revision (commit sha) that was deployed, or false if the deploy failed
     def deploy(deploy_ref, with_maintenance:)
-      deploy_ref_description = deploy_ref_describe(deploy_ref)
+      revision = resolve_revision(deploy_ref)
+      return false unless revision
+
+      deploy_ref_description = deploy_ref_describe(revision)
       puts "Deploy #{deploy_ref_description} to #{target} with migrate=#{target.migrate_in_release_phase ? "(during release phase)" : migrate_outside_of_release_phase?} with_maintenance=#{with_maintenance} "
 
-      output_to_be_deployed(deploy_ref)
+      output_to_be_deployed(revision)
       configuration.before_deploying(self, target, deploy_ref_description)
-      successful_push = puts_and_system "git push -f #{target.git_remote} #{deploy_ref || target}^{}:#{target.heroku_target_ref}"
+      successful_push = puts_and_system "git push -f #{target.git_remote} #{revision}:#{target.heroku_target_ref}"
 
       return false unless successful_push
 
@@ -30,12 +41,22 @@ module HerokuTool
       app_revision_env_var = configuration.app_revision_env_var
       if app_revision_env_var && app_revision_env_var != "HEROKU_SLUG_COMMIT"
         # HEROKU_SLUG_COMMIT is automatically set by https://devcenter.heroku.com/articles/dyno-metadata
-        puts_and_system %{heroku config:set #{app_revision_env_var}=$(git describe --always #{deploy_ref}) -a #{target.heroku_app}}
+        puts_and_system "heroku config:set #{app_revision_env_var}=#{Shellwords.escape(deploy_ref_description)} -a #{target.heroku_app}"
       end
 
       maintenance_off if with_maintenance
       configuration.after_deploying(self, target, deploy_ref_description)
-      true
+      revision
+    end
+
+    # @return [String, nil] the sha of the commit that deploy_ref (or the target's deploy_ref) points at right now
+    def resolve_revision(deploy_ref = nil)
+      deploy_ref ||= target.deploy_ref
+      revision = `git rev-parse --verify --quiet #{deploy_ref}^{commit}`.strip
+      return revision unless revision.empty?
+
+      puts "❌ Can't resolve '#{deploy_ref}' to a commit"
+      nil
     end
 
     def maintenance_on
@@ -53,7 +74,7 @@ module HerokuTool
     end
 
     def deploy_ref_describe(deploy_ref = nil)
-      `git describe #{deploy_ref || target.deploy_ref}`.strip
+      `git describe --always #{deploy_ref || target.deploy_ref}`.strip
     end
 
     def output_to_be_deployed(since_deploy_ref = nil)
@@ -65,10 +86,10 @@ module HerokuTool
     end
 
     # @return [Boolean] true if the command was successful
-    def puts_and_system(cmd)
-      puts cmd
+    def puts_and_system(cmd, *args)
+      puts([cmd, *args].join(" "))
       puts "-------------"
-      system_with_clean_env(cmd).tap do |result|
+      system_with_clean_env(cmd, *args).tap do |result|
         if result
           puts "-------------"
         else
@@ -77,30 +98,31 @@ module HerokuTool
       end
     end
 
-    def puts_and_exec(cmd)
-      puts cmd
-      exec_with_clean_env(cmd)
+    def puts_and_exec(cmd, *args)
+      puts([cmd, *args].join(" "))
+      exec_with_clean_env(cmd, *args)
     end
 
-    def exec_with_clean_env(cmd)
-      if defined?(Bundler) && Bundler.respond_to?(:with_unbundled_env)
-        Bundler.with_unbundled_env { `#{cmd}` }
+    def exec_with_clean_env(cmd, *args)
+      output, _status = if defined?(Bundler) && Bundler.respond_to?(:with_unbundled_env)
+        Bundler.with_unbundled_env { Open3.capture2(cmd, *args) }
       elsif defined?(Bundler)
-        Bundler.with_clean_env { `#{cmd}` }
+        Bundler.with_clean_env { Open3.capture2(cmd, *args) }
       else
-        `#{cmd}`
+        Open3.capture2(cmd, *args)
       end
+      output
     end
 
     protected
 
-    def system_with_clean_env(cmd)
+    def system_with_clean_env(cmd, *args)
       if defined?(Bundler) && Bundler.respond_to?(:with_unbundled_env)
-        Bundler.with_unbundled_env { system cmd }
+        Bundler.with_unbundled_env { system(cmd, *args) }
       elsif defined?(Bundler)
-        Bundler.with_clean_env { system cmd }
+        Bundler.with_clean_env { system(cmd, *args) }
       else
-        system cmd
+        system(cmd, *args)
       end
     end
   end

data/lib/heroku_tool/tasks/heroku.thor

@@ -135,9 +135,9 @@ class Heroku < Thor
     check_deploy_ref(deploy_ref)
     with_maintenance = options[:maintenance].nil? && migrate_outside_of_release_phase? || options[:maintenance] || false
     deploy_ref ||= target.deploy_ref
-    success = commander.deploy(deploy_ref, with_maintenance: with_maintenance)
-    if success
-      deploy_tracking(target_name, deploy_ref)
+    deployed_revision = commander.deploy(deploy_ref, with_maintenance: with_maintenance)
+    if deployed_revision
+      deploy_tracking(target_name, deployed_revision)
     else
       exit(-1)
     end
@@ -194,24 +194,35 @@ class Heroku < Thor
     end
 
     def notify_bugsnag_of_deploy_tracking(deploy_ref:, revision:)
-      api_key = ENV["BUGSNAG_API_KEY"]
-      data = %W[
-        apiKey=#{api_key}
-        releaseStage=#{target.trackable_release_stage}
-        repository=#{target.repository}
-        revision=#{revision}
-        appVersion=#{deploy_ref_describe(deploy_ref)}
-      ].join("&")
-      if api_key.blank?
+      api_key = ENV["BUGSNAG_API_KEY"].presence || "API_KEY"
+
+      app_version = deploy_ref_describe(deploy_ref)
+      json_data = {
+        apiKey: api_key,
+        appVersion: app_version,
+        sourceControl: {
+          repository: target.repository,
+          revision: revision
+        },
+        releaseStage: target.trackable_release_stage
+      }
+
+      args = [
+        "-H", "Content-Type: application/json",
+        "-H", "apiKey: #{api_key}",
+        "-H", "appVersion: #{app_version}",
+        "-d", json_data.to_json,
+        "https://build.bugsnag.com"
+      ]
+      if api_key == "API_KEY"
         puts "\n" + ("*" * 80) + "\n"
-        command = "curl -d #{data} http://notify.bugsnag.com/deploy"
-        puts command
+        puts("curl #{args.join(" ")}")
         puts "\n" + ("*" * 80) + "\n"
         puts "NB: can't notify unless you specify BUGSNAG_API_KEY and rerun"
         puts "  thor heroku:deploy_tracking #{target.name} #{deploy_ref}"
-      else
-        puts_and_system "curl -d \"#{data}\" http://notify.bugsnag.com/deploy"
+        return
       end
+      puts_and_system("curl", *args)
     end
   end
 

data/lib/heroku_tool/version.rb

@@ -1,3 +1,3 @@
 module HerokuTool
-  VERSION = "0.9.1"
+  VERSION = "0.9.3"
 end

data/release_notes/__TEMPLATE__.md

@@ -0,0 +1,4 @@
+$VERSION Release Notes
+
+*Changes since $PREVIOUS*
+

data/release_notes/v0.9.2.md

@@ -0,0 +1,5 @@
+v0.9.2 Release Notes
+
+*Changes since v0.9.1*
+
+- update and fix bugsnag deploy tracking (#17)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku_tool
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Tim Diggins
@@ -150,6 +150,8 @@ files:
 - lib/heroku_tool/tasks/db_drop_all_tables.rake
 - lib/heroku_tool/tasks/heroku.thor
 - lib/heroku_tool/version.rb
+- release_notes/__TEMPLATE__.md
+- release_notes/v0.9.2.md
 - templates/Rakefile
 - templates/heroku.thor
 - templates/heroku_targets.yml