dlss-capistrano 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c8f550ec45bd1d6633ac6868fc417aefc33b64ba8ef8134b14cb40f61c01c48
-  data.tar.gz: 2d1d900f77b688e06e7ccfaa314494307947b0a43ac19bdda7b0c163263f19f8
+  metadata.gz: 877a173e1e6e8e32cd4c48df5cf8b59011114d87994f5e747924cab409bf37d2
+  data.tar.gz: 5a0cc74142192b5e4c4a77809d318f0b4dcd138ecd488ff787e78de3ce2a8486
 SHA512:
-  metadata.gz: d3e1f76b839e71f7aaf1103d865ab0a30051161d3dd8360d525ee0486c554409a0ddcf8758f4b5081e36815710caa4d484790cab04f675e378a0f4fdcae97394
-  data.tar.gz: a266d77daf559af7cf561587f4ed5e47e27d79dad8afe835d3f38884cbb23cdd64f81dd5ecad3acdb6adc998540d57c3115ed071b971d5392abb248de5dadcea
+  metadata.gz: 21fbedcc886454cd536e083edc07a73e38842e1bbd9dbaba00b1de9e8912b8eac2f7ef3bf902d5885f960199be7224ec6709c05c6b2da295d90118cfe6e54f21
+  data.tar.gz: 9dc3c858babe7710cef6f6a5b50878206bff508977048e226a54387b1f58cd84a5ccc9328e34b01a9c0f2a1a79e484b780d45aca23247db7e14a5ca46791a0d1

data/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Why was this change made?
+
+
+
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

data/README.md

@@ -20,6 +20,17 @@ set :bundler2_config_path, '/tmp' # set to '#{shared_path}/bundle' by default
 
 Note that only `bundler2_config_use_hook` **must** be set in order to use this functionality.
 
+### Sidekiq symlink
+
+Every time the version of Sidekiq or Ruby changes, a corresponding Puppet PR must be made in order to update the XSendFilePath that allows Apache to access the bundled Sidekiq gem's assets. dlss-capistrano provides a hook to create a symlink to the bundled Sidekiq to avoid having to do this:
+
+```ruby
+set :bundled_sidekiq_symlink, true # false is the default value
+set :bundled_sidekiq_roles, [:app] # this is the default value
+```
+
+Set this in `config/deploy.rb` to automate the symlink creation, and then use `XSendFilePath /path/to/my/app/shared/bundled_sidekiq/web/assets` in Apache configuration (in Puppet).
+
 ### SSH
 
 `cap ENV ssh` establishes an SSH connection to the host running in `ENV` environment, and changes into the current deployment directory

data/dlss-capistrano.gemspec

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

data/lib/dlss/capistrano.rb

@@ -2,6 +2,4 @@ require 'capistrano/one_time_key'
 require 'capistrano/bundle_audit'
 require 'capistrano/shared_configs'
 
-load File.expand_path('../capistrano/tasks/bundle_config.rake', __FILE__)
-load File.expand_path('../capistrano/tasks/sidekiq_systemd.rake', __FILE__)
-load File.expand_path('../capistrano/tasks/ssh.rake', __FILE__)
+Dir.glob("#{__dir__}/capistrano/tasks/*.rake").each { |r| import r }

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

@@ -0,0 +1,31 @@
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :bundled_sidekiq_symlink, fetch(:bundled_sidekiq_symlink, false)
+    set :bundled_sidekiq_roles, fetch(:bundled_sidekiq_roles, [:app])
+  end
+end
+
+# Integrate sidekiq-bundle hook into Capistrano
+namespace :deploy do
+  before :starting, :add_bundled_sidekiq_hook do
+    invoke 'bundled_sidekiq:add_hook' if fetch(:bundled_sidekiq_symlink)
+  end
+end
+
+namespace :bundled_sidekiq do
+  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+  task :add_hook do
+    after 'bundler:install', 'bundled_sidekiq:symlink'
+  end
+
+  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+  task :symlink do
+    on roles fetch(:bundled_sidekiq_roles) do
+      within release_path do
+        bundled_sidekiq_path = capture(:bundle, :info, '--path', :sidekiq)
+        execute(:ln, '-sf', bundled_sidekiq_path, "#{shared_path}/bundled_sidekiq")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -76,6 +76,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".gitignore"
 - Gemfile
 - LICENSE
@@ -85,6 +86,7 @@ files:
 - lib/dlss.rb
 - lib/dlss/capistrano.rb
 - lib/dlss/capistrano/tasks/bundle_config.rake
+- lib/dlss/capistrano/tasks/bundled_sidekiq.rake
 - lib/dlss/capistrano/tasks/sidekiq_systemd.rake
 - lib/dlss/capistrano/tasks/ssh.rake
 - lib/lyberteam-capistrano-devel.rb