slackistrano 4.0.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f28f0c81b8d8772f9b77f26c0f3f069ea770630f94c63d91affc4724e397415
-  data.tar.gz: 49771347f5329cff33061b3fe4a83c2b785d7922dc57f420b766a0b9515798fc
+  metadata.gz: 6360f02d5cef2b9905f62b56bc447c20f19ead2c2eb395c5d75fab47acac5b40
+  data.tar.gz: 5fc2245b992c98e4e48cbe8ba648d7a6b990947c054614acb6b4946dba848817
 SHA512:
-  metadata.gz: 578f583688d88ac3c0092d8f4da674bae4b562c58bb0c120d24cd4c77e38b744e8eb0310125a148d7bcf2c03beef70b8f2968051121a372db160b9c9c6ffb18c
-  data.tar.gz: 83f90a56bd3e2a067fd9437417e2fef5ef0853bf59d56fc87160982f482acd31022cb7a82d91018552396cc963836ea8e5a0f991e7533ea8321a53b7ee1651e8
+  metadata.gz: 3c3eb27e2685c88ad3a6961ab78e9b568d13becdcfbac9a94f0b7bb51d43d7b91121acfab080718276efdffe6fd33900c0d6a0897079528c7e8020c7fac2b526
+  data.tar.gz: 53df379711d05ff2b08f0ec98d5b42ecfacb9f07790f6412839f039fd16230e677a46463c1945c2a747e2f544733e4d52baf6499ed2d265e675e5d06166ef647

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Slackistrano Change Log
 
+4.0.2
+-----
+
+- Make it possible to overwrite all slackistrano hooks [#98]
+
+4.0.1
+-----
+
+- Send message on deploy:starting in addition to deploy:updating [#93]
+
 4.0.0
 -----
 
@@ -63,4 +73,3 @@
 - **BREAKING:** Renamed all `***_starting` settings to `***_updating`
 - **BREAKING:** Renamed all `***_finished` settings to `***_updated`
 - Added rollback options `***_reverting` and `***_reverted` [#19, #31]
-

data/README.md

@@ -100,6 +100,25 @@ $ cap production slack:deploy:test
 Deploy your application like normal and you should see messages in the channel
 you specified.
 
+## Customizing the hooks
+
+If you wish to take control over when and what slackistrano hooks are fired, then you can use the option in `deploy.rb`:
+
+```ruby
+set :use_custom_slackistrano_hooks, true
+```
+
+This allows you to set custom hooks for all the slackistrano tasks:
+
+```ruby
+'slack:deploy:starting'
+'slack:deploy:updating'
+'slack:deploy:reverting'
+'slack:deploy:updated'
+'slack:deploy:reverted'
+'slack:deploy:failed'
+```
+
 ## Customizing the Messaging
 
 You can customize the messaging posted to Slack by providing your own messaging
@@ -120,6 +139,11 @@ if defined?(Slackistrano::Messaging)
          end
        end
 
+       # Suppress starting message.
+       def payload_for_starting
+         nil
+       end
+
        # Suppress updating message.
        def payload_for_updating
          nil
@@ -216,7 +240,7 @@ To set this up:
 
 ## Disabling posting to Slack
 
-You can disable deployment notifications to a specific stage by setting the `:slackistrano` 
+You can disable deployment notifications to a specific stage by setting the `:slackistrano`
 configuration variable to `false` instead of actual settings.
 
 ```ruby

data/lib/slackistrano/messaging/base.rb

@@ -22,12 +22,18 @@ module Slackistrano
         @webhook = options.delete(:webhook)
       end
 
-      def payload_for_updating
+      def payload_for_starting
         {
           text: "#{deployer} has started deploying branch #{branch} of #{application} to #{stage}"
         }
       end
 
+      def payload_for_updating
+        {
+          text: "#{deployer} is deploying branch #{branch} of #{application} to #{stage}"
+        }
+      end
+
       def payload_for_reverting
         {
           text: "#{deployer} has started rolling back branch #{branch} of #{application} to #{stage}"

data/lib/slackistrano/messaging/default.rb

@@ -2,6 +2,10 @@ module Slackistrano
   module Messaging
     class Default < Base
 
+      def payload_for_starting
+        super
+      end
+
       def payload_for_updating
         super
       end

data/lib/slackistrano/messaging/null.rb

@@ -1,6 +1,10 @@
 module Slackistrano
   module Messaging
     class Null < Base
+      def payload_for_starting
+        nil
+      end
+
       def payload_for_updating
         nil
       end

data/lib/slackistrano/tasks/slack.rake

@@ -1,6 +1,11 @@
 namespace :slack do
   namespace :deploy do
 
+    desc 'Notify about starting deploy'
+    task :starting do
+      Slackistrano::Capistrano.new(self).run(:starting)
+    end
+
     desc 'Notify about updating deploy'
     task :updating do
       Slackistrano::Capistrano.new(self).run(:updating)
@@ -27,15 +32,18 @@ namespace :slack do
     end
 
     desc 'Test Slack integration'
-    task :test => %i[updating updated reverting reverted failed] do
+    task :test => %i[starting updating updated reverting reverted failed] do
       # all tasks run as dependencies
     end
 
   end
 end
 
-before 'deploy:updating',           'slack:deploy:updating'
-before 'deploy:reverting',          'slack:deploy:reverting'
-after  'deploy:finishing',          'slack:deploy:updated'
-after  'deploy:finishing_rollback', 'slack:deploy:reverted'
-after  'deploy:failed',             'slack:deploy:failed'
+unless fetch(:use_custom_slackistrano_hooks, false)
+  before 'deploy:starting',           'slack:deploy:starting'
+  before 'deploy:updating',           'slack:deploy:updating'
+  before 'deploy:reverting',          'slack:deploy:reverting'
+  after  'deploy:finishing',          'slack:deploy:updated'
+  after  'deploy:finishing_rollback', 'slack:deploy:reverted'
+  after  'deploy:failed',             'slack:deploy:failed'
+end

data/lib/slackistrano/version.rb

@@ -1,3 +1,3 @@
 module Slackistrano
-  VERSION = '4.0.0'
+  VERSION = '4.0.2'
 end

data/spec/capistrano_deploy_stubs.rake

@@ -1,4 +1,6 @@
 namespace :deploy do
+  task :starting do
+  end
   task :updating do
   end
   task :reverting do

data/spec/disabling_posting_to_slack_spec.rb

@@ -6,7 +6,7 @@ describe Slackistrano do
       set :slackistrano, false
     end
     
-    %w[updating reverting updated reverted failed].each do |stage|
+    %w[starting updating reverting updated reverted failed].each do |stage|
       it "doesn't post on slack:deploy:#{stage}" do
         expect_any_instance_of(Slackistrano::Capistrano).not_to receive(:post)
         Rake::Task["slack:deploy:#{stage}"].execute

data/spec/dry_run_spec.rb

@@ -11,7 +11,7 @@ describe Slackistrano do
     set :slackistrano, { klass: DryRunMessaging }
   end
 
-  %w[updating reverting updated reverted failed].each do |stage|
+  %w[starting updating reverting updated reverted failed].each do |stage|
     it "does not post to slack on slack:deploy:#{stage}" do
       allow_any_instance_of(Slackistrano::Capistrano).to receive(:dry_run?).and_return(true)
       expect_any_instance_of(Slackistrano::Capistrano).to receive(:post_dry_run)

data/spec/posting_to_multiple_channels_spec.rb

@@ -8,7 +8,7 @@ describe Slackistrano do
   end
 
   context "when :slack_channel is an array" do
-    %w[updating reverting updated reverted failed].each do |stage|
+    %w[starting updating reverting updated reverted failed].each do |stage|
       it "posts to slack on slack:deploy:#{stage} in every channel" do
         expect_any_instance_of(Slackistrano::Capistrano).to receive(:post).twice
         Rake::Task["slack:deploy:#{stage}"].execute

data/spec/task_hooks_spec.rb

@@ -4,6 +4,10 @@ describe Slackistrano do
 
   describe "before/after hooks" do
 
+    it "invokes slack:deploy:starting before deploy:starting" do
+      expect(Rake::Task['deploy:starting'].prerequisites).to include 'slack:deploy:starting'
+    end
+
     it "invokes slack:deploy:updating before deploy:updating" do
       expect(Rake::Task['deploy:updating'].prerequisites).to include 'slack:deploy:updating'
     end
@@ -28,7 +32,7 @@ describe Slackistrano do
     end
 
     it "invokes all slack:deploy tasks before slack:deploy:test" do
-      expect(Rake::Task['slack:deploy:test'].prerequisites).to match %w[updating updated reverting reverted failed]
+      expect(Rake::Task['slack:deploy:test'].prerequisites).to match %w[starting updating updated reverting reverted failed]
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slackistrano
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.2
 platform: ruby
 authors:
 - Philip Hallstrom
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -104,7 +104,7 @@ homepage: https://github.com/phallstrom/slackistrano
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Send notifications to Slack about Capistrano deployments.
 test_files: