capistrano-opscomplete 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a111086da8ada5ac2feb628dde0145658192aab86de0c3ff4ce18645b49ded6e
-  data.tar.gz: 9d264bca1f519365f7fd16cfab80e1351ef39f26e5ed1b8fac146fb648580b06
+  metadata.gz: 2c5c6ec21950e64171120fc314ea2b909ceb7262fd1175732a93f5897b9a6933
+  data.tar.gz: daa695ea2c44e828cd82ee95c37cecc8ab6257421d1c8e7b05b5876cf5912a46
 SHA512:
-  metadata.gz: 6255e9bfb88b90ee0a24d22b08c77ff186dcb83f6d7b782e1c2f92c6c75fc829fb2cc1be84bcd5786eb39452f6a0be2b8bb0b5321b6dfafc01c0b87f60805f51
-  data.tar.gz: 260cbaaa98160b36fbb89b58ff86db5d5a386ad0a8aab72306b660c98d23bebe0cdefec7f5d8fc8185e485dcd872ccebef3d017b7ea66e5cf556018d2e317ab2
+  metadata.gz: 93c67f0e7960afb7b4c691cdd170b43215cc119b236beebe9b4bfb492dca3ca9d55d7e819d56bd034415c833669b0196291a6ff904c9df16c2dcb251d8e04243
+  data.tar.gz: 558e16c5063b40ff09ca57c0c4312454622cb3ca91a1b4817a1465ef8a424a65513162378792c97a5bf433b9ac130c411e7ac0ce8c367b75e34d5e859387408e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## [0.6.0] - 2020-01-13
+### Added
+
+- Support for Procfiles/supervisord. See [this makandra card](https://makandracards.com/opscomplete/67829-procfile-support) for more information.
+
 ## [0.5.0] - 2019-12-09
 ### Changed
 - Install the bundler version that was used to create the `Gemfile.lock` (`BUNDLED WITH`) if it is present. Can be overwritten by `set :bundler_version`.
@@ -13,7 +18,6 @@
 - Allow using --force when installing a gem e.g. overwrite binaries
 - Quote some shell arguments
 
-
 ## [0.3.0] - 2019-04-05
 ### Added
 - You can now specify the rubygems and bundler version to be installed. (#4)
@@ -42,6 +46,7 @@
 ### Added
 - Initial release.
 
+[0.6.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.2.0...v0.3.0

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    capistrano-opscomplete (0.6.0)
+      capistrano (>= 3.0, < 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.4.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    ast (2.4.0)
+    capistrano (3.11.2)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.1.5)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    makandra-rubocop (4.2.0)
+      rubocop (~> 0.76.0)
+      rubocop-rails (~> 2.3.2)
+    net-scp (2.0.0)
+      net-ssh (>= 2.6.5, < 6.0.0)
+    net-ssh (5.2.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rack (2.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rails (2.3.2)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    ruby-progressbar (1.10.1)
+    sshkit (1.20.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2)
+  capistrano-opscomplete!
+  makandra-rubocop (~> 4)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -28,13 +28,45 @@ Verify the gem was installed and tasks are available:
 
     $ bundle exec cap -T opscomplete
 
-Now, add some [hooks](#using-capistrano-hooks) in your capistrano configuration. An example configuration could look like this:
+Now, add some [hooks](#using-capistrano-hooks) in your capistrano configuration (e.g. `deploy.rb`).
+An example configuration could look like this:
 
 ```ruby
 # After unpacking your release, before bundling, compiling assets, ...
 after 'deploy:updating', 'opscomplete:ruby:ensure'
 ```
 
+and in case you enabled [`Procfile support`](https://makandracards.com/opscomplete/67829-procfile-support) you can use the following tasks:
+
+    opscomplete:supervisor:gen_config
+    opscomplete:supervisor:restart_procs
+    opscomplete:supervisor:stop_procs
+    opscomplete:supervisor:signal_procs
+
+e.g. like this:
+
+```ruby
+# Update and Restart supervisor config
+after 'deploy:updating', 'opscomplete:supervisor:gen_config'
+after 'deploy:published', 'opscomplete:supervisor:restart_procs'
+```
+
+Using the default configuration, these tasks will run on all Servers where role is `:app` using the Procfile called `Procfile`.
+To change the role where these tasks will get executed, set `:procfile_role` in e.g. your `config/deploy.rb` like:
+
+```ruby
+# Use supervisor tasks only for sidekiq role
+set :procfile_role, :sidekiq
+```
+
+If you want to run different Procfiles on differen servers, you can set the `:procfile` property in your `config/deploy/${env}.rb`:
+
+```
+# In this example, `Procfile` will get used for supervisor on srv2.example.com and `Procfile.sidekiq` for supervisor on srv1.example.com.
+server "srv1.example.com", user: "deploy-example_s", roles: %w{app web}, procfile: "Procfile.sidekiq"
+server "srv2.example.com", user: "deploy-example_s", roles: %w{app web}
+```
+
 ## Usage
 
 If you encounter any errors, please make sure you have the newest version of the capistrano-opscomplete gem installed. Don't hesitate to contact the OpsComplete for Ruby team for further support.

data/capistrano-opscomplete.gemspec

@@ -14,7 +14,12 @@ Gem::Specification.new do |spec|
   spec.license  = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata = {
+      'allowed_push_host' => 'https://rubygems.org',
+      'bug_tracker_uri' => 'https://github.com/makandra/capistrano-opscomplete/issues',
+      'changelog_uri' => 'https://github.com/makandra/capistrano-opscomplete/blob/master/CHANGELOG.md',
+      'source_code_uri' => 'https://github.com/makandra/capistrano-opscomplete',
+    }
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'
@@ -32,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.required_rubygems_version = '>=2.0.1'
 
   spec.add_development_dependency 'makandra-rubocop', '~> 4'
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rake', '~> 10.0'
 
   spec.add_dependency 'capistrano', '>=3.0', '<4.0.0'

data/lib/capistrano/opscomplete.rb

@@ -1,4 +1,5 @@
 require 'capistrano/opscomplete/version'
 
-load File.expand_path('opscomplete/tasks.rake', __dir__)
+load File.expand_path('opscomplete/ruby.rake', __dir__)
+load File.expand_path('opscomplete/supervisor.rake', __dir__)
 load File.expand_path('opscomplete/deploy.rake', __dir__)

data/lib/capistrano/opscomplete/supervisor.rake

@@ -0,0 +1,59 @@
+# vim: filetype=ruby
+namespace :opscomplete do
+  namespace :supervisor do
+    desc '(Re-)Generate the supervisor configuration (e.g. for supervisord).'
+    task :gen_config do
+      on roles fetch(:procfile_role, :app) do |host|
+        within release_path do
+          execute :supervisor_gen_config, host.properties.procfile
+        end
+      end
+    end
+
+    desc 'Reread the supervisor configuration and (re)start all Procfile processes'
+    task :restart_procs do
+      on roles fetch(:procfile_role, :app) do
+        within release_path do
+          execute :supervisor_restart_procs
+        end
+      end
+    end
+
+    desc 'Stop all Procfile processes in case you want to them to be stopped while your deployment runs'
+    task :stop_procs do
+      on roles fetch(:procfile_role, :app) do
+        within release_path do
+          execute :supervisor_stop_procs
+        end
+      end
+    end
+    
+    # Can be used for example to quiet sidekiq with a task like this:
+    #
+    #     namespace :sidekiq do
+    #       desc 'quiet all sidekiq processes so they stop accepting new jobs.'
+    #       task :quiet do
+    #         on roles :cron do
+    #           # The TSTP signal tells sidekiq to quiet all workers.
+    #           # see: https://github.com/mperham/sidekiq/wiki/Signals#tstp
+    #           invoke('supervisor:signal_procs', 'TSTP', 'sidekiq')
+    #         end
+    #       end
+    #     end
+    desc 'Sends the signal (e.g. USR1 or TSTP) to all programs or if specified to program_name.'
+    task :signal_procs, :signal, :program_name do |task_name, args|
+      signal = args.fetch(:signal)
+      program_name = args.fetch(:program_name, nil)
+
+      on roles fetch(:procfile_role, :app) do
+        within release_path do
+          if program_name
+            execute :supervisor_signal_procs, signal, program_name
+          else
+            execute :supervisor_signal_procs, signal
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/opscomplete/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Opscomplete
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-opscomplete
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2020-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makandra-rubocop
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -90,13 +91,17 @@ files:
 - lib/capistrano/dsl/opscomplete.rb
 - lib/capistrano/opscomplete.rb
 - lib/capistrano/opscomplete/deploy.rake
-- lib/capistrano/opscomplete/tasks.rake
+- lib/capistrano/opscomplete/ruby.rake
+- lib/capistrano/opscomplete/supervisor.rake
 - lib/capistrano/opscomplete/version.rb
 homepage: https://opscomplete.com/ruby
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/makandra/capistrano-opscomplete/issues
+  changelog_uri: https://github.com/makandra/capistrano-opscomplete/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/makandra/capistrano-opscomplete
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.1
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Capistrano tasks for easy deployment to a makandra opscomplete environment.