dlss-capistrano 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 567a3f876085fa1cdc2de7ed0d79b874ca479674a82d158a32dece1d66316a92
-  data.tar.gz: 2cabff7242f8966857e68d05a27dfec7664192c094bbacf007b4bea605b7cab3
+  metadata.gz: 4bf8c65ac4ab455803d2c5a0bf37a552cf4f058c6e16d40980d2e372055d949b
+  data.tar.gz: 80276f5cda72a4d4d126bc5ef9e1e0b80c7f4fe9483de2f8f582a4d2139b14fc
 SHA512:
-  metadata.gz: fca3a41b870e3b4050847bc283481a55066fc32ae36719ebed145f4771fe2ef9d70b76494bc5b44e43e372322a5f5df8dd9ee59b2c0bdefaead5a58ac2c0078d
-  data.tar.gz: 93dfc1d74b6de88f4a9d69bcac565faa5ad4262f694dbfef1f0ca5d77ab89a2ebcd016ca4898d826cb1076d882bba879797171d587ea5e277e6c32954e23d172
+  metadata.gz: bad31704f2aa552e08a2361201fcc82cbb772a3f8bbd4952d46410ea1667f17227dfaf67856d8646addef27d7bf3bf6610b1c908a375336e37990e6824b74f92
+  data.tar.gz: 79377df1b16a760dad8a35d45101533557b98c76e704e601fce30df3c99caec950e99b28913f1d10c213f1853c707a089fe8a03f6fbd5dae62432cb79ad9939d

data/README.md

@@ -6,6 +6,8 @@ This gem provides Capistrano deployment tasks used by Stanford Libraries' Digita
 
 ## Necessary setup
 
+To use controlmaster, you need to opt-in by setting the environment variable `USE_CAPISTRANO_CONTROLMASTER=true` (in e.g. your `~/.zshenv` file or similar for your particular shell).
+
 If you use values other than the defaults for  `CONTROLMASTER_HOST` (`dlss-jump`) or `CONTROLMASTER_SOCKET` (`"~/.ssh/%r@%h:%p"`), you'll want to set these environment variables locally to the values you use (in e.g. your `~/.zshenv` file or similar for your particular shell).  Otherwise, the gem will fail to connect to the appropriate host and/or won't be able to properly check the status of the control master process.
 
 The control master host is the value of the `ProxyJump` directive in your SSH config, and the control master socket is the value of the `ControlPath` directive in your SSH config.

data/dlss-capistrano.gemspec

@@ -4,7 +4,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "dlss-capistrano"
-  s.version     = '5.0.0'
+  s.version     = '5.0.1'
 
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Chris Beer", 'Mike Giarlo']

data/lib/dlss/capistrano/tasks/control_master.rake

@@ -2,8 +2,13 @@
 
 require 'open3'
 
-CONTROLMASTER_HOST = ENV.fetch('CONTROLMASTER_HOST', 'dlss-jump')
-CONTROLMASTER_SOCKET = ENV.fetch('CONTROLMASTER_SOCKET', "~/.ssh/%r@%h:%p")
+namespace :load do
+  task :defaults do
+    set :use_controlmaster, ENV.fetch('USE_CAPISTRANO_CONTROLMASTER', false) == 'true'
+    set :controlmaster_host, ENV.fetch('CONTROLMASTER_HOST', 'dlss-jump')
+    set :controlmaster_socket, ENV.fetch('CONTROLMASTER_SOCKET', "~/.ssh/%r@%h:%p")
+  end
+end
 
 # Integrate hook into Capistrano
 namespace :deploy do
@@ -15,12 +20,14 @@ end
 namespace :controlmaster do
   desc 'set up an SSH controlmaster process if missing'
   task :setup do
+    next unless fetch(:use_controlmaster)
+
     if fetch(:log_level) == :debug
-      puts "checking if controlmaster process exists (#{CONTROLMASTER_SOCKET}) for #{CONTROLMASTER_HOST}"
+      puts "checking if controlmaster process exists (#{fetch(:controlmaster_socket)}) for #{fetch(:controlmaster_host)}"
     end
 
     status, output = Open3.popen2e(
-      "ssh -O check -S #{CONTROLMASTER_SOCKET} #{CONTROLMASTER_HOST}"
+      "ssh -O check -S #{CONTROLMASTER_SOCKET} #{fetch(:controlmaster_host)}"
     ) { |_, outerr, wait_thr| next wait_thr.value, outerr.read }
 
     if status.success?
@@ -34,12 +41,14 @@ namespace :controlmaster do
 
   # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
   task :start do
+    next unless fetch(:use_controlmaster)
+
     if fetch(:log_level) == :debug
-      puts "creating new controlmaster process for #{CONTROLMASTER_HOST} at #{CONTROLMASTER_SOCKET}"
+      puts "creating new controlmaster process for #{fetch(:controlmaster_host)} at #{fetch(:controlmaster_socket)}"
     end
 
     status, output = Open3.popen2e(
-      "ssh -f -N -S #{CONTROLMASTER_SOCKET} #{CONTROLMASTER_HOST}"
+      "ssh -f -N -S #{fetch(:controlmaster_socket)} #{fetch(:controlmaster_host)}"
     ) { |_, outerr, wait_thr| next wait_thr.value, outerr.read }
 
     if status.success?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Capistrano recipes for use in SUL/DLSS projects