capistrano-bundler 1.3.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b1c1916ab0e176f784186ee7ea028c18b0559c1
-  data.tar.gz: ecbe8ef7523ca08be476d843f15e49ca87521265
+SHA256:
+  metadata.gz: 8053398d08ff32053d03773eee9c1e5d1a3984e681fc4e88b9154b3d51ede801
+  data.tar.gz: 8bf98c42d9eed292d72d3a0993122b0d4c3b7ff4fa5ae0c2099d47c23ce9f05c
 SHA512:
-  metadata.gz: 77a72d5a04ae297c6e9197c0e5b9bd12eb36df53b378d7c30260e9c237df941a0665518125af959697591f71d6e05eaecd22bff3f03d72e5e3be2795ab065d02
-  data.tar.gz: 05d8115080a4bc9280d67995ef6a7e64bfbea7be550988c8e340ec80907a687d758843bf18edb6c579f77886d66b77a7eaccdf4490a24fb2581c5dc2d7f22f77
+  metadata.gz: c980a9df70ef8f627147349540992413c6fe47a1744d17f802a5d2b278be573e9be9073de698f17854307a34dffcfd21b51d2cd355cfe324e003c8c37d0f525f
+  data.tar.gz: f37e5b38046f9b89e6d8fd17d786190563b2ffa98162cbb3d83caccd42c0ab87034307bfca8dc538c5c81d2c1b23f1b22bf9d9b1622f79701de703ad30a90caa

data/.github/release-drafter.yml

@@ -0,0 +1,17 @@
+name-template: "$NEXT_PATCH_VERSION"
+tag-template: "v$NEXT_PATCH_VERSION"
+categories:
+  - title: "⚠️ Breaking Changes"
+    label: "⚠️ Breaking"
+  - title: "✨ New Features"
+    label: "✨ Feature"
+  - title: "🐛 Bug Fixes"
+    label: "🐛 Bug Fix"
+  - title: "📚 Documentation"
+    label: "📚 Docs"
+  - title: "🏠 Housekeeping"
+    label: "🏠 Housekeeping"
+change-template: "- $TITLE (#$NUMBER) @$AUTHOR"
+no-changes-template: "- No changes"
+template: |
+  $CHANGES

data/.github/workflows/push.yml

@@ -0,0 +1,14 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.travis.yml

@@ -1,6 +1,9 @@
-sudo: false
+---
 language: ruby
+cache: bundler
+branches:
+  only:
+    - master
 rvm:
-  - 2.3.3
-before_install: gem install bundler -v '~> 1.14' --conservative
-before_script: bundle exec danger
+  - 2.7.1
+script: bundle exec danger

data/CHANGELOG.md

@@ -1,62 +1 @@
-# [Unreleased][] (master)
-
-* Your contribution here!
-
-# [1.3.0][] (22 Sep 2017)
-
-Breaking changes
-
-* None
-
-Added
-
-* Set all variables in `load:defaults` task so they are recognised as valid Capistrano settings when using `doctor:variables` and ensure defaults for `bundle_env_variables` and `bundle_clean_options` are set once in the same place as the other defaults.
-
-# [1.2.0][] (1 Oct 2016)
-
-Breaking changes
-
-* None
-
-Added
-
-* A `bundle clean` task.  There are no default hooks for it.
-* Use `bundle check` to check if we can skip `bundle install`
-* Run `bundle:install` on rollback (`deploy:reverted`)
-* You can now `require "capistrano/bundler/tasks"` to load the tasks only without the hooks
-
-# 1.1.4 (22 Jan 2015)
-
-* Don’t generate binstubs by default (#61)
-
-# 1.1.3 (4 Aug 2014)
-
-* Honor `:no_release` flag by using `release_roles` in Capistrano 3.1
-* capistrano-bundler now requires Capistrano 3.1 or higher (~> 3.1)
-* Added `:bundle_jobs` option for specifying number of parallel jobs
-
-# 1.1.2 (8 Feb 2014)
-
-* Added `bundle_env_variables` option for specifying environment variables that should be set when running `bundle`.
-* The `bundle_dir` option is now named `bundle_path`
-* Use `bundle install` instead of `bundle`
-* All options are now optional and can be excluded from the final bundle command by setting them to `nil`
-* Bundler looks for a `Gemfile` by default, so there is no need to specify it.
-
-# 1.1.1
-
-* ruby is not prefixed with `bundle exec` anymore by default
-* prefix rails with `bundle exec` by default
-
-# 1.1.0
-
-* Switching to new command map (https://github.com/capistrano/sshkit/pull/45)
-  Thanks to new command map, now this integration adds `bundle exec` to global executables (gem, ruby, rake). The list of executable can be tweaked by `bundle_bins`.
-
-# 1.0.0
-
-Initial release
-
-[Unreleased]: https://github.com/capistrano/bundler/compare/v1.3.0...HEAD
-[1.3.0]: https://github.com/capistrano/bundler/compare/v1.2.0...v1.3.0
-[1.2.0]: https://github.com/capistrano/bundler/compare/v1.1.4...v1.2.0
+Release notes for this project are kept here: https://github.com/capistrano/bundler/releases

data/Dangerfile

@@ -1 +1 @@
-danger.import_dangerfile(github: "capistrano/danger")
+danger.import_dangerfile(github: "capistrano/danger", branch: "no-changelog")

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Capistrano, your one stop deployment shop.
+Copyright (c) 2020 Capistrano, your one stop deployment shop.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -14,7 +14,7 @@ Add these lines to your application's Gemfile **[Recommended]**:
 
 ```ruby
 gem 'capistrano', '~> 3.6'
-gem 'capistrano-bundler', '~> 1.3'
+gem 'capistrano-bundler', '~> 2.0'
 ```
 
 And then execute:
@@ -37,11 +37,33 @@ Require in `Capfile` to use the default task:
 require 'capistrano/bundler'
 ```
 
-The task will run before `deploy:updated` as part of Capistrano's default deploy, or can be run in isolation with `cap production bundler:install`
+The task will run before `deploy:updated` as part of Capistrano's default deploy, or can be run in isolation with `cap production bundler:install`.
+
+In order for Bundler to work efficiently on the server, its project configuration directory (`<release_path>/.bundle/`) should be persistent across releases.
+You need to add it to the `linked_dirs` Capistrano variable:
+
+Capistrano **3.5**+:
+
+```ruby
+# config/deploy.rb
+
+append :linked_dirs, '.bundle'
+```
+
+Capistrano < 3.5:
+
+```ruby
+# config/deploy.rb
+
+set :linked_dirs, fetch(:linked_dirs, []) << '.bundle'
+```
+
+It will still work fine with non-persistent configuration directory, but then it will have to re-resolve all gems on each deploy.
 
 By default, the plugin adds `bundle exec` prefix to common executables listed in `bundle_bins` option. This currently applies for `gem`, `rake` and `rails`.
 
 You can add any custom executable to this list:
+
 ```ruby
 set :bundle_bins, fetch(:bundle_bins, []).push('my_new_binary')
 ```
@@ -50,21 +72,23 @@ Configurable options:
 
 ```ruby
 set :bundle_roles, :all                                         # this is default
+set :bundle_config, { deployment: true }                        # this is default
 set :bundle_servers, -> { release_roles(fetch(:bundle_roles)) } # this is default
 set :bundle_binstubs, -> { shared_path.join('bin') }            # default: nil
 set :bundle_gemfile, -> { release_path.join('MyGemfile') }      # default: nil
-set :bundle_path, -> { shared_path.join('bundle') }             # this is default. set it to nil for skipping the --path flag.
+set :bundle_path, -> { shared_path.join('bundle') }             # this is default. set it to nil to use bundler's default path
 set :bundle_without, %w{development test}.join(' ')             # this is default
-set :bundle_flags, '--deployment --quiet'                       # this is default
+set :bundle_flags, '--quiet'                                    # this is default
 set :bundle_env_variables, {}                                   # this is default
 set :bundle_clean_options, ""                                   # this is default. Use "--dry-run" if you just want to know what gems would be deleted, without actually deleting them
+set :bundle_check_before_install, true                          # default: true. Set this to false to bypass running `bundle check` before executing `bundle install`
 ```
 
 You can parallelize the installation of gems with bundler's jobs feature.
 Choose a number less or equal than the number of cores your server.
 
 ```ruby
-set :bundle_jobs, 4 # default: nil, only available for Bundler >= 1.4
+set :bundle_jobs, 8 # default: 4, only available for Bundler >= 1.4
 ```
 
 To generate binstubs on each deploy, set `:bundle_binstubs` path:
@@ -73,19 +97,18 @@ To generate binstubs on each deploy, set `:bundle_binstubs` path:
 set :bundle_binstubs, -> { shared_path.join('bin') }
 ```
 
-In the result this would execute the following bundle command on all servers
+In the result this would execute the following bundle commands on all servers
 (actual paths depend on the real deploy directory):
 
 ```sh
-$ bundle install \
-  --binstubs /my_app/shared/bin \
-  --gemfile /my_app/releases/20130623094732/MyGemfile \
-  --path /my_app/shared/bundle \
-  --without development test \
-  --deployment --quiet
+$ bundle config --local deployment true
+$ bundle config --local gemfile /my_app/releases/20130623094732/MyGemfile
+$ bundle config --local path /my_app/shared/bundle
+$ bundle config --local without "development test"
+$ bundle install --quiet --binstubs /my_app/shared/bin
 ```
 
-If any option is set to `nil` it will be excluded from the final bundle command.
+If any option is set to `nil` it will be excluded from the final bundle commands.
 
 If you want to clean up gems after a successful deploy, add `after 'deploy:published', 'bundler:clean'` to config/deploy.rb.
 

data/Rakefile

@@ -2,3 +2,8 @@ require "bundler/gem_tasks"
 
 # Do nothing by default
 task :default
+
+Rake::Task["release"].enhance do
+  puts "Don't forget to publish the release on GitHub!"
+  system "open https://github.com/capistrano/bundler/releases"
+end

data/capistrano-bundler.gemspec

@@ -4,13 +4,16 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'capistrano-bundler'
-  spec.version       = '1.3.0'
+  spec.version       = '2.0.1'
+  spec.license       = 'MIT'
   spec.authors       = ['Tom Clements', 'Lee Hambley', 'Kir Shatrov']
   spec.email         = ['seenmyfate@gmail.com', 'lee.hambley@gmail.com', 'shatrov@me.com']
   spec.description   = %q{Bundler support for Capistrano 3.x}
   spec.summary       = %q{Bundler support for Capistrano 3.x}
   spec.homepage      = 'https://github.com/capistrano/bundler'
-  spec.license       = 'MIT'
+  spec.metadata      = {
+    "changelog_uri" => "https://github.com/capistrano/bundler/releases"
+  }
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -18,9 +21,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'capistrano', '~> 3.1'
-  spec.add_dependency 'sshkit', '~> 1.2'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'danger'
   spec.add_development_dependency 'rake'
 end

data/lib/capistrano/tasks/bundler.cap

@@ -1,9 +1,39 @@
+require "shellwords"
+
 namespace :bundler do
   desc <<-DESC
-        Install the current Bundler environment. By default, gems will be \
-        installed to the shared/bundle path. Gems in the development and \
-        test group will not be installed. The install command is executed \
-        with the --deployment and --quiet flags.
+        Configure the Bundler environment for the release so that subequent
+        `bundle check`, `bundle install`, `bundle clean`, and `bundle exec`
+        commands all behave consistently. The following settings will be
+        turned into the appropriate `bundle config` executions:
+
+        :bundle_config
+        :bundle_gemfile
+        :bundle_path
+        :bundle_without
+    DESC
+  task :config do
+    on fetch(:bundle_servers) do
+      within release_path do
+        with fetch(:bundle_env_variables) do
+          configuration = fetch(:bundle_config).dup || {}
+          configuration[:gemfile] = fetch(:bundle_gemfile)
+          configuration[:path] = fetch(:bundle_path)
+          configuration[:without] = fetch(:bundle_without)
+
+          configuration.each do |key, value|
+            execute :bundle, "config", "--local", key, value.to_s.shellescape unless value.nil?
+          end
+        end
+      end
+    end
+  end
+
+  desc <<-DESC
+        Install the current Bundler environment. By default, gems will be
+        installed to the shared/bundle path. Gems in the development and
+        test group will not be installed. The install command is executed
+        with the --quiet and --jobs=4 flags.
 
         By default, bundler will not be run on servers with no_release: true.
 
@@ -11,27 +41,27 @@ namespace :bundler do
 
           set :bundle_roles, :all
 
+          set :bundle_config, { deployment: true }
           set :bundle_servers, -> { release_roles(fetch(:bundle_roles)) }
-          set :bundle_binstubs, -> { shared_path.join('bin') }
+          set :bundle_binstubs, nil
           set :bundle_gemfile, -> { release_path.join('Gemfile') }
           set :bundle_path, -> { shared_path.join('bundle') }
           set :bundle_without, %w{development test}.join(' ')
-          set :bundle_flags, '--deployment --quiet'
-          set :bundle_jobs, nil
+          set :bundle_flags, '--quiet'
+          set :bundle_jobs, 4
           set :bundle_env_variables, {}
           set :bundle_clean_options, ""
     DESC
-  task :install do
+  task install: :config do
     on fetch(:bundle_servers) do
       within release_path do
         with fetch(:bundle_env_variables) do
-          options = []
-          options << "--gemfile #{fetch(:bundle_gemfile)}" if fetch(:bundle_gemfile)
-          options << "--path #{fetch(:bundle_path)}" if fetch(:bundle_path)
-          unless test(:bundle, :check, *options)
+          if fetch(:bundle_check_before_install) && test(:bundle, :check)
+            info "The Gemfile's dependencies are satisfied, skipping installation"
+          else
+            options = []
             options << "--binstubs #{fetch(:bundle_binstubs)}" if fetch(:bundle_binstubs)
             options << "--jobs #{fetch(:bundle_jobs)}" if fetch(:bundle_jobs)
-            options << "--without #{fetch(:bundle_without)}" if fetch(:bundle_without)
             options << "#{fetch(:bundle_flags)}" if fetch(:bundle_flags)
             execute :bundle, :install, *options
           end
@@ -53,7 +83,7 @@ namespace :bundler do
   end
 
   desc "Remove unused gems installed by bundler"
-  task :clean do
+  task clean: :config do
     on fetch(:bundle_servers) do
       within release_path do
         with fetch(:bundle_env_variables) do
@@ -73,14 +103,17 @@ namespace :load do
     set :bundle_bins, %w{gem rake rails}
 
     set :bundle_roles, :all
+
+    set :bundle_config, { deployment: true }
     set :bundle_servers, -> { release_roles(fetch(:bundle_roles)) }
     set :bundle_binstubs, nil
     set :bundle_gemfile, nil
     set :bundle_path, -> { shared_path.join('bundle') }
-    set :bundle_without, %w{development test}.join(' ')
-    set :bundle_flags, '--deployment --quiet'
-    set :bundle_jobs, nil
+    set :bundle_without, %w{development test}.join(':')
+    set :bundle_flags, '--quiet'
+    set :bundle_jobs, 4
     set :bundle_env_variables, {}
     set :bundle_clean_options, ""
+    set :bundle_check_before_install, true
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-bundler
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Tom Clements
 - Lee Hambley
 - Kir Shatrov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -26,34 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: sshkit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: danger
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +77,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/release-drafter.yml"
+- ".github/workflows/push.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -109,8 +97,9 @@ files:
 homepage: https://github.com/capistrano/bundler
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/capistrano/bundler/releases
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,9 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Bundler support for Capistrano 3.x
 test_files: []