capistrano-pinned_releases 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9eb06bbc1091855f3aa33d024cd4798b51a79d100cb3009ac7cf1e8e0fa409b
+  data.tar.gz: 21e59938678f9980b3d9dda91453310c98bc5e2af495167e2090d60a8654a54d
+SHA512:
+  metadata.gz: 9a21f6c8ca0ea9aded3251312d47148ba62d2d5cef63483c6dd7b36d7984da31355b9b3f32a7003f9b396e1032b55a0bc41b5ee065ed08d5ad1acf28f03ceb6b
+  data.tar.gz: 09e708442c8c547be07091c1e75590a0fede7ed6880da5ff15e412c9e6e111dfc3b7b7db244f387a6d0330d71e883b7522b2dde290e02e8ca2c1651fc841cbc7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+capistrano-pinned_releases-*.gem

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - lib/capistrano/tasks/deploy.rb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-pinned_releases.gemspec
+gemspec
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    capistrano-pinned_releases (1.0.0)
+      capistrano (~> 3.4)
+      capistrano-bundler (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.3.1)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.11.0)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-bundler (1.5.0)
+      capistrano (~> 3.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (5.1.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    sshkit (1.18.2)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  capistrano-pinned_releases!
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.1

data/README.md

@@ -0,0 +1,84 @@
+# Capistrano: Pinned Releases
+
+📌 Pin and unpin capistrano releases. Pinned releases don't get deleted during cleanup. 
+
+✋ **Capistrano 3.0+ only**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-pinned_releases'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install capistrano-pinned_releases
+
+## Usage
+
+The extension provides following tasks, all under the `deploy:pinned` namespace.
+
+1. **`list`**: List all currently pinned releases:
+ 
+        deploy:pinned:list
+
+    This prints a comma separated list of currently pinned releases:
+    
+        ** Execute deploy:pinned:list
+        20190220192205, 20190225190753
+
+2. **`pin`**: Pin a given release: 
+
+        cap production deploy:pinned:pin RELEASE_NAME=20190220192205
+        
+    without the `RELEASE_NAME` environment variable, it pins the current release:
+    
+        cap production deploy:pinned:pin
+
+3. **`unpin`**: Unpin a given release:
+
+        deploy:pinned:unpin RELEASE_NAME=20190220192205
+
+    without the `RELEASE_NAME` environment variable, it pins the current release:
+    
+        deploy:pinned:unpin
+
+These tasks can be run individually, but they're far more useful when used during the capistrano release lifecycle:
+
+        after 'sidekiq:restart', 'deploy:pinned:pin'
+        
+Or, as a part of other tasks:
+
+```ruby
+rake my_task: :environment do
+  if capture(:some_command_on_server, :arg1, :arg2)
+    invoke 'deploy:pinned:pin'
+  else
+    invoke 'deploy:pinned:unpin'
+  end
+end
+
+# etc.
+```
+
+⚠️ This extension overrides the default `deploy:cleanup` task, in order to prevent releases from getting deployed. If you have an extension that also overrides the default behavior on `deploy:cleanup`, then this extension won't work for you. To work around, make sure you are not calling
+
+```ruby
+Rake::Task["deploy:cleanup"].clear_actions
+```
+anywhere within your code.
+
+
+## Development
+
+Please fork your copy, and do all your work on a appropriately named branch. After checking out the repo, run `bin/setup` to install dependencies.
+
+## Contributing
+
+Bug reports and pull requests are welcome!

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-pinned_releases.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/pinned_releases/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "capistrano-pinned_releases"
+  spec.version = Capistrano::PinnedReleases::VERSION
+  spec.authors = ["Swanand Pagnis"]
+  spec.email = ["swanand.pagnis@gmail.com"]
+  spec.summary = "Pin and unpin releases. Pinned releases are not deleted during cleanup"
+  spec.homepage = "https://github.com/swanandp/capistrano-pinned_releases"
+
+  spec.description = <<~TEXT
+    "Pin releases: Pin an arbitrary release and prevent it from getting deleted during `deploy:cleanup`.
+    Unpin the release to unprotect it"
+  TEXT
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  raise "RubyGems 2.0 or newer is required to protect against public gem pushes." unless spec.respond_to?(:metadata)
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/swanandp/capistrano-pinned_releases"
+  spec.metadata["changelog_uri"] = "https://github.com/swanandp/capistrano-pinned_releases/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", "~> 3.4"
+  spec.add_dependency "capistrano-bundler", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/pinned_releases.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "capistrano/pinned_releases/version"
+require "capistrano/pinned_releases/i18n"
+require "capistrano/tasks/deploy"
+
+module Capistrano
+  # Your code goes here...
+  module PinnedReleases
+  end
+end

data/lib/capistrano/pinned_releases/i18n.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+en = {
+  wont_delete_pinned_release: "The release '%{release}' is pinned; it won't be deleted from %{host}",
+}
+
+I18n.backend.store_translations(:en, capistrano: en)

data/lib/capistrano/pinned_releases/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module PinnedReleases
+    VERSION = "1.0.0"
+  end
+end

data/lib/capistrano/tasks/deploy.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+namespace :deploy do
+  namespace :check do
+    desc "Check shared and release directories exist"
+    task :directories do
+      on release_roles :all do
+        execute :mkdir, "-p", deploy_path.join("pinned_releases")
+      end
+    end
+  end
+
+  namespace :pinned do
+    # rubocop:disable Metrics/LineLength
+    desc "Pin a given release: 'cap production deploy:pin:release RELEASE_NAME=20190220192205', without RELEASE_NAME pins the current release"
+    # rubocop:enable Metrics/LineLength
+    task pin: "deploy:check" do
+      on release_roles :all do
+        release_name = ENV.fetch("RELEASE_NAME", "current")
+        releases_directory = deploy_path.join("releases")
+        pinned_releases_directory = deploy_path.join("pinned_releases")
+
+        if release_name == "current"
+          current_release_path = capture(:readlink, release_path.parent.join(current_path.basename))
+          current_release_name = capture(:basename, current_release_path)
+
+          pin_target = current_release_path
+          pin_name = pinned_releases_directory.join(current_release_name)
+        else
+          pin_target = releases_directory.join(release_name)
+          pin_name = pinned_releases_directory.join(release_name)
+        end
+
+        execute :ln, "-s", pin_target, pin_name
+      end
+    end
+
+    # rubocop:disable Metrics/LineLength
+    desc "Unpin a given release: 'cap production deploy:pin:remove RELEASE_NAME=20190220192205', without RELEASE_NAME unpins the current release"
+    # rubocop:enable Metrics/LineLength
+    task unpin: "deploy:check" do
+      on release_roles :all do
+        release_name = ENV.fetch("RELEASE_NAME", "current")
+        pinned_releases_directory = deploy_path.join("pinned_releases")
+
+        if release_name == "current"
+          current_release_path = capture(:readlink, release_path.parent.join(current_path.basename))
+          current_release_name = capture(:basename, current_release_path)
+
+          pin_name = pinned_releases_directory.join(current_release_name)
+        else
+          pin_name = pinned_releases_directory.join(release_name)
+        end
+
+        execute :rm, "-f", pin_name
+      end
+    end
+
+    desc "List all currently pinned releases"
+    task list: "deploy:check" do
+      on release_roles :all do
+        pinned_releases_directory = deploy_path.join("pinned_releases")
+        pinned_releases = capture :ls, pinned_releases_directory
+        puts pinned_releases.split(/\s+/).sort.join(", ")
+      end
+    end
+  end
+
+  desc "Clean up old releases"
+  Rake::Task["deploy:cleanup"].clear_actions
+  task cleanup: "check:directories" do
+    on release_roles :all do |host|
+      releases = capture(:ls, "-x", releases_path).split
+      valid, invalid = releases.partition { |e| /^\d{14}$/ =~ e }
+
+      warn t(:skip_cleanup, host: host.to_s) if invalid.any?
+
+      if valid.count >= fetch(:keep_releases)
+        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: valid.count)
+        directories =
+          (valid - valid.last(fetch(:keep_releases))).map do |release|
+            releases_path.join(release).to_s
+          end.reject do |release|
+            release_name = capture(:basename, release)
+
+            if test("[ -d #{deploy_path.join('pinned_releases').join(release_name)} ]")
+              warn t(:wont_delete_pinned_release, host: host.to_s, release: release_name)
+              true
+            else
+              false
+            end
+          end
+
+        if test("[ -d #{current_path} ]")
+          current_release = capture(:readlink, current_path).to_s
+
+          if directories.include?(current_release)
+            warn t(:wont_delete_current_release, host: host.to_s)
+            directories.delete(current_release)
+          end
+        else
+          debug t(:no_current_release, host: host.to_s)
+        end
+
+        if directories.any?
+          execute :rm, "-rf", *directories
+        else
+          info t(:no_old_releases, host: host.to_s, keep_releases: fetch(:keep_releases))
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-pinned_releases
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Swanand Pagnis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: capistrano-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |
+  "Pin releases: Pin an arbitrary release and prevent it from getting deleted during `deploy:cleanup`.
+  Unpin the release to unprotect it"
+email:
+- swanand.pagnis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/setup
+- capistrano-pinned_releases.gemspec
+- lib/capistrano/pinned_releases.rb
+- lib/capistrano/pinned_releases/i18n.rb
+- lib/capistrano/pinned_releases/version.rb
+- lib/capistrano/tasks/deploy.rb
+homepage: https://github.com/swanandp/capistrano-pinned_releases
+licenses: []
+metadata:
+  homepage_uri: https://github.com/swanandp/capistrano-pinned_releases
+  source_code_uri: https://github.com/swanandp/capistrano-pinned_releases
+  changelog_uri: https://github.com/swanandp/capistrano-pinned_releases/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Pin and unpin releases. Pinned releases are not deleted during cleanup
+test_files: []