egads 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b26a0eb6c696433c8d0d9f5b7096d9fb810882c9ccc54a5e5165d12e965e08e
-  data.tar.gz: d2229d72f7ed72dd980da57b57dc8076cc8775293d016b7b0be7a691de33320c
+  metadata.gz: '09258b7cad1e80200b4a8b3d6d47efffb9111f4fbe98ad5891d282db31f80e32'
+  data.tar.gz: ecded76960e9067e64730e6f2289635622a658b13d2ec8cd1c6a61b733882a20
 SHA512:
-  metadata.gz: d1acba8d3973c141fb9ecb0f3fd041fca8b6d570ee37782dc14c3c4007a4a4211269edfc1f7d0885fad1556c35ed9479f5015850ad69be3c85d7f59f6459dc92
-  data.tar.gz: 92272667f510eb9652d780a6a38420079d98b13c9cdf45af31448e2e1175f96bd1763409006514587ed81bda9c9a5bd2d56f813dda58ee99be04cee9567ac8d4
+  metadata.gz: 9493f4ce2b5c34b24f3422a8aa076b7a77816b00db3140de4d0aea6c3f1c8b5e8ba71d349037980b309e530502b55e9211b32fc06275a61bf0bd9fea31eb7468
+  data.tar.gz: e9b3ed9c711f7b0f01e45cc2ffa8310e83a6747b20ab6f3edbdd656c9efba420c19722c9bdd4044531fd24ab39387f0dd923b8cddb00a9ab98b4bffcdf2f0462

data/.github/actions/setup-rubygems/action.yml

@@ -0,0 +1,18 @@
+name: Setup RubyGems
+description: Setup RubyGems credentials
+inputs:
+  api-key:
+    description: RubyGems API key
+    required: true
+runs:
+  using: composite
+  steps:
+    - name: setup rubygems
+      shell: bash
+      run: |
+        mkdir -p ~/.gem
+        cat <<-YAML > ~/.gem/credentials
+        ---
+        :rubygems_api_key: ${{ inputs.api-key }}
+        YAML
+        chmod 0600 ~/.gem/credentials

data/.github/workflows/test-release.yml

@@ -0,0 +1,48 @@
+name: Test and Release
+on:
+  pull_request:
+  push:
+    paths:
+      - .github/**
+      - bin/**
+      - lib/**
+      - spec/**
+      - Gemfile
+      - Guardfile
+      - Rakefile
+      - egads.gemspec
+  release:
+    types:
+      - published
+jobs:
+  test:
+    name: Test [Ruby ${{ matrix.ruby-version }}]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - "3.2"
+          - "3.3"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - run: bundle install
+      - run: bundle exec rake test
+  push:
+    name: Publish Gem
+    if: ${{ github.event.release }}
+    needs:
+      - test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+      - uses: ./.github/actions/setup-rubygems
+        with:
+          api-key: ${{ secrets.RUBYGEMS_API_KEY }}
+      - run: bundle install
+      - run: bundle exec rake gem:push

data/.gitignore

@@ -17,3 +17,5 @@ tmp
 .yardoc
 _yardoc
 doc/
+
+.ruby-version

data/README.md

@@ -1,6 +1,8 @@
 # egads!!!
 # *Extensible Git-Archive Deploy Strategy*
 
+[![Test and Release](https://github.com/kickstarter/egads/actions/workflows/test-release.yml/badge.svg)](https://github.com/kickstarter/egads/actions/workflows/test-release.yml)
+
 egads is a set of commands for deploying applications without depending on a git
 server.
 
@@ -13,13 +15,17 @@ Climate](https://d3s6mut3hikguw.cloudfront.net/github/kickstarter/egads.svg)](ht
 
 Put `egads` in your Gemfile:
 
-    # In Gemfile
-    gem 'egads', require: nil
+```ruby
+# ./Gemfile
+gem 'egads', require: nil
+```
 
 On remote machines (to which you deploy), `egads` must be in your PATH.
 So install `egads` as a system gem:
 
-    sudo gem install egads
+```bash
+gem install egads
+```
 
 ## Commands
 
@@ -31,8 +37,8 @@ Commands are either *porcelain* commands that you should call directly as part o
 
 ### Local commands
 
-* `egads check [SHA]` - checks if a deployable tarball of the current commit exists on S3.
-* `egads build [SHA]` - makes a deployable tarball of the current commit and upload it to S3 (if missing).
+* `egads check SHA` - checks if a deployable tarball of the current commit exists on S3.
+* `egads build SHA` - makes a deployable tarball of the current commit and upload it to S3 (if missing).
 * `egads upload SHA` - (plumbing, called by `build`) Uploads a pre-built tarball.
 
 ### Remote commands
@@ -57,6 +63,15 @@ The deploy process is:
 * Run `egads stage SHA` on all the remote servers to download, extract, and configure the SHA for release.
 * Run `egads release SHA` on all the remote servers to symlink the staged SHA to 'current', and restart services.
 
+## Publishing a New Gem Version
+
+To publish a new version of `egads`:
+
+1. Update [`Egads::VERSION`](./lib/egads/version.rb)
+2. Commit and push to GitHub
+3. Create a new [GitHub release](https://github.com/kickstarter/egads/releases)
+4. Monitor the [Test and Release](https://github.com/kickstarter/egads/actions/workflows/test-release.yml) action to ensure the gem is published successfully
+
 ## License
 
 Copyright (c) 2013 Kickstarter, Inc

data/Rakefile

@@ -1,10 +1,29 @@
 require "rubygems"
 require "bundler/setup"
-require "bundler/gem_tasks"
 require 'rake/testtask'
 
+task :default => :test
+
 Rake::TestTask.new do |t|
   t.pattern = "spec/*_spec.rb"
 end
 
-task :default => :test
+namespace :gem do
+  require 'bundler/gem_tasks'
+
+  @gem = "pkg/egads-#{ Egads::VERSION }.gem"
+
+  desc "Push #{ @gem } to rubygems.org"
+  task :push => %i[test build git:check] do
+    sh %{gem push #{ @gem }}
+  end
+end
+
+namespace :git do
+  desc 'Check git workspace'
+  task :check do
+    sh %{git diff HEAD --quiet} do |ok|
+      abort "\e[31mRefusing to continue - git workspace is dirty\e[0m" unless ok
+    end
+  end
+end

data/Taskfile.yml

@@ -0,0 +1,14 @@
+# https://taskfile.dev
+
+version: "3"
+
+tasks:
+  init:
+    desc: Initialize project
+    cmds:
+      - bundle install
+
+  test:
+    desc: Run tests
+    cmds:
+      - bundle exec rake test

data/egads.gemspec

@@ -2,29 +2,31 @@ $:.unshift 'lib'
 require 'egads/version'
 
 Gem::Specification.new do |s|
-  s.name              = "egads"
-  s.version           = Egads::VERSION
-  s.summary           = "Extensible Git Archive Deploy Strategy"
-  s.homepage          = "https://github.com/kickstarter/egads"
-  s.email             = ["aaron@ktheory.com"]
-  s.authors           = ["Aaron Suggs"]
-  s.license           = 'MIT'
+  s.name     = "egads"
+  s.version  = Egads::VERSION
+  s.summary  = "Extensible Git Archive Deploy Strategy"
+  s.homepage = "https://github.com/kickstarter/egads"
+  s.email    = ["aaron@ktheory.com"]
+  s.authors  = ["Aaron Suggs"]
+  s.license  = 'MIT'
 
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.extra_rdoc_files  = [ "README.md" ]
+  s.extra_rdoc_files  = ["README.md"]
   s.rdoc_options      = ["--charset=UTF-8"]
 
   s.add_dependency "aws-sdk-s3", '~> 1.0'
+  s.add_dependency "rexml", ">= 3.3.4" # required for Ruby 3+
   s.add_dependency "thor"
+
   s.add_development_dependency "rake"
   s.add_development_dependency "minitest"
-  #s.add_development_dependency "simple_mock" # Via http://tatey.com/2012/02/07/mocking-with-minitest-mock-and-simple-delegator/
 
-  s.description = %s{
+  s.description = <<~EOS
     A collection of scripts for making a deployable tarball of a git commit,
-    uploading it to Amazon S3, and downloading it to your servers.}
+    uploading it to Amazon S3, and downloading it to your servers.
+  EOS
 end

data/lib/egads/command/extract.rb

@@ -3,6 +3,7 @@ module Egads
     include Thor::Actions
 
     desc "[remote, plumbing] Downloads tarball for SHA from S3 and extracts it to the filesystem"
+    class_option :deployment_id, type: :string, default: nil, banner: 'Append suffix to release directory'
     class_option :force, type: :boolean, aliases: '-f', default: false, banner: "Overwrite existing files"
     argument :sha, type: :string, required: true, desc: 'git SHA to download and extract'
 
@@ -89,7 +90,8 @@ module Egads
 
     # Directory created upon successful extraction
     def release_dir
-      RemoteConfig.release_dir(sha)
+      suffix = options[:deployment_id] ? "_#{options[:deployment_id]}" : ''
+      RemoteConfig.release_dir(sha) + suffix
     end
 
     # Directory where in-progress extraction occurs
@@ -104,7 +106,7 @@ module Egads
     end
 
     def should_download?(path)
-      options[:force] || File.zero?(path) || !File.exists?(path)
+      options[:force] || File.zero?(path) || !File.exist?(path)
     end
 
     def should_extract?

data/lib/egads/command/release.rb

@@ -3,6 +3,7 @@ module Egads
     include Thor::Actions
 
     desc "[remote] Symlinks SHA to current and restarts services. If needed, stages SHA"
+    class_option :deployment_id, type: :string, default: nil, banner: 'Append suffix to release directory'
     class_option :force, type: :boolean, default: false, banner: "Overwrite existing release"
     argument :sha, type: :string, required: true, desc: 'git SHA to stage'
     def setup_environment
@@ -44,8 +45,10 @@ module Egads
     end
 
     protected
+    
     def dir
-      RemoteConfig.release_dir(sha)
+      suffix = options[:deployment_id] ? "_#{options[:deployment_id]}" : ''
+      RemoteConfig.release_dir(sha) + suffix
     end
 
     def release_to

data/lib/egads/command/stage.rb

@@ -2,8 +2,8 @@ module Egads
   class Stage < Group
     include Thor::Actions
 
-
     desc "[remote] Readies SHA for release. If needed, generates URL for SHA and extracts"
+    class_option :deployment_id, type: :string, default: nil, banner: 'Append suffix to release directory'
     class_option :force, type: :boolean, default: false, banner: "Overwrite existing files"
     argument :sha, type: :string, required: true, desc: 'git SHA to stage'
 
@@ -57,8 +57,10 @@ module Egads
     end
 
     protected
+    
     def dir
-      RemoteConfig.release_dir(sha)
+      suffix = options[:deployment_id] ? "_#{options[:deployment_id]}" : ''
+      RemoteConfig.release_dir(sha) + suffix
     end
 
     def stage_flag_path
@@ -66,7 +68,7 @@ module Egads
     end
 
     def should_stage?
-      options[:force] || !File.exists?(stage_flag_path)
+      options[:force] || !File.exist?(stage_flag_path)
     end
 
     def shared_path
@@ -74,5 +76,3 @@ module Egads
     end
   end
 end
-
-

data/lib/egads/config.rb

@@ -6,9 +6,14 @@ module Egads
     end
 
     def s3_bucket
-      return @bucket if @bucket
-      client = Aws::S3::Client.new(access_key_id: config['s3']['access_key'], secret_access_key: config['s3']['secret_key'], region: 'us-east-1')
-      @bucket = Aws::S3::Bucket.new(config['s3']['bucket'], client: client)
+      @bucket ||= begin
+        client = Aws::S3::Client.new(**{
+          access_key_id:     config['s3']['access_key'],
+          secret_access_key: config['s3']['secret_key'],
+          region:            config['s3']['region'],
+        }.compact)
+        Aws::S3::Bucket.new(config['s3']['bucket'], client: client)
+      end
     end
 
     def s3_prefix

data/lib/egads/version.rb

@@ -1,3 +1,3 @@
 module Egads
-  VERSION = '5.1.0'
+  VERSION = '5.2.0'
 end

data/spec/egads_build_spec.rb

@@ -4,21 +4,21 @@ describe "Egads::Build" do
   subject { Egads::Build }
 
   it 'should run the correct tasks' do
-    subject.commands.keys.must_equal %w(check_build run_before_build_hooks write_revision_file commit_extra_paths make_tarball run_after_build_hooks upload)
+    _(subject.commands.keys).must_equal %w(check_build run_before_build_hooks write_revision_file commit_extra_paths make_tarball run_after_build_hooks upload)
   end
 
   it 'takes one argument' do
-    subject.arguments.size.must_equal 1
+    _(subject.arguments.size).must_equal 1
   end
 
   it 'has a rev argument' do
     rev = subject.arguments.detect{|arg| arg.name == 'rev'}
-    rev.default.must_equal 'HEAD'
-    rev.required.must_equal false
+    _(rev.default).must_equal 'HEAD'
+    _(rev.required).must_equal false
   end
 
   it "exits on failure" do
-    subject.exit_on_failure?.must_equal true
+    _(subject.exit_on_failure?).must_equal true
   end
 end
 
@@ -26,6 +26,6 @@ describe "Egags::Build instance" do
   subject { Egads::Build.new }
 
   it "has rev HEAD" do
-    subject.rev.must_equal 'HEAD'
+    _(subject.rev).must_equal 'HEAD'
   end
 end

data/spec/egads_check_spec.rb

@@ -4,17 +4,17 @@ describe "Egads::Check" do
   subject { Egads::Check }
 
   it 'should run the correct tasks' do
-    subject.commands.keys.must_equal %w(check)
+    _(subject.commands.keys).must_equal %w(check)
   end
 
   it 'takes one argument' do
-    subject.arguments.size.must_equal 1
+    _(subject.arguments.size).must_equal 1
   end
 
   it 'has a rev argument' do
     rev = subject.arguments.detect{|arg| arg.name == 'rev'}
-    rev.default.must_equal 'HEAD'
-    rev.required.must_equal false
+    _(rev.default).must_equal 'HEAD'
+    _(rev.required).must_equal false
   end
 
 end
@@ -23,6 +23,6 @@ describe "Egags::Build instance" do
   subject { Egads::Check.new }
 
   it "has rev HEAD" do
-    subject.rev.must_equal 'HEAD'
+    _(subject.rev).must_equal 'HEAD'
   end
 end

data/spec/egads_command_spec.rb

@@ -3,6 +3,6 @@ require_relative 'spec_helper'
 describe "Egads::Command" do
   subject { Egads::Command }
   it 'should exit on failure' do
-    subject.exit_on_failure?.must_equal true
+    _(subject.exit_on_failure?).must_equal true
   end
 end

data/spec/egads_config_spec.rb

@@ -5,7 +5,7 @@ describe Egads::Config do
   subject { Egads::Config }
   it "raises ArgumentError for missing config" do
     ENV['EGADS_CONFIG'] = '/no/such/path'
-    -> { subject.config_path }.must_raise(ArgumentError)
+    _{ subject.config_path }.must_raise(ArgumentError)
   end
 
   describe "with an config file" do
@@ -14,16 +14,16 @@ describe Egads::Config do
 
     describe '#config' do
       it 'is a hash' do
-        subject.config.must_equal yml
+        _(subject.config).must_equal yml
       end
     end
 
     it "has an S3 bucket" do
-      subject.s3_bucket.name.must_equal yml['s3']['bucket']
+      _(subject.s3_bucket.name).must_equal yml['s3']['bucket']
     end
 
     it "has an S3 prefix" do
-      subject.s3_prefix.must_equal yml['s3']['prefix']
+      _(subject.s3_prefix).must_equal yml['s3']['prefix']
     end
   end
 
@@ -34,21 +34,21 @@ describe Egads::RemoteConfig do
 
   it "raises ArgumentError for missing config" do
     ENV['EGADS_REMOTE_CONFIG'] = '/no/such/path'
-    -> { subject.config_path }.must_raise(ArgumentError)
+    _{ subject.config_path }.must_raise(ArgumentError)
   end
 
   describe "with an config file" do
     let(:yml) { YAML.load_file("example/egads_remote.yml") }
 
     describe '#config' do
-      it('is a hash') { subject.config.must_equal yml }
+      it('is a hash') { _(subject.config).must_equal yml }
     end
 
-    it('#release_to') { subject.release_to.must_equal yml['release_to'] }
-    it('#extract_to') { subject.extract_to.must_equal yml['extract_to'] }
-    it('#release_dir') { subject.release_dir('abc').must_equal File.join(yml['extract_to'], 'abc') }
-    it('#restart_command') { subject.restart_command.must_equal yml['restart_command'] }
-    it('#bundler_options') { subject.bundler_options.must_equal yml['bundler']['options'] }
+    it('#release_to') { _(subject.release_to).must_equal yml['release_to'] }
+    it('#extract_to') { _(subject.extract_to).must_equal yml['extract_to'] }
+    it('#release_dir') { _(subject.release_dir('abc')).must_equal File.join(yml['extract_to'], 'abc') }
+    it('#restart_command') { _(subject.restart_command).must_equal yml['restart_command'] }
+    it('#bundler_options') { _(subject.bundler_options).must_equal yml['bundler']['options'] }
 
     describe '#setup_environment' do
       before { subject.setup_environment }
@@ -59,7 +59,7 @@ describe Egads::RemoteConfig do
 
       it 'should set ENV values' do
         yml['env'].each do |key, value|
-          ENV[key].must_equal value
+          _(ENV[key]).must_equal value
         end
       end
     end

data/spec/egads_extract_spec.rb

@@ -4,6 +4,6 @@ describe "Egads::Extract" do
   subject { Egads::Extract }
 
   it 'should run the correct tasks' do
-  subject.commands.keys.must_equal %w(setup_environment extract)
+  _(subject.commands.keys).must_equal %w(setup_environment extract)
   end
 end

data/spec/egads_release_spec.rb

@@ -4,6 +4,6 @@ describe "Egads::Release" do
   subject { Egads::Release }
 
   it 'should run the correct tasks' do
-  subject.commands.keys.must_equal %w(setup_environment stage run_before_release_hooks symlink_release restart run_after_release_hooks trim)
+  _(subject.commands.keys).must_equal %w(setup_environment stage run_before_release_hooks symlink_release restart run_after_release_hooks trim)
   end
 end

data/spec/egads_s3_tarball_spec.rb

@@ -5,16 +5,16 @@ describe Egads::S3Tarball do
 
   after { Aws.config.delete(:s3) }
 
-  it('has a sha') { subject.sha.must_equal 'sha' }
-  it('has a key') { subject.key.must_equal 'my_project/sha.tar.gz' }
+  it('has a sha') { _(subject.sha).must_equal 'sha' }
+  it('has a key') { _(subject.key).must_equal 'my_project/sha.tar.gz' }
 
   it "has an S3 bucket" do
-    subject.bucket.name.must_equal Egads::Config.s3_bucket.name
+    _(subject.bucket.name).must_equal Egads::Config.s3_bucket.name
   end
 
   it('should not exist') {
     Aws.config[:s3] = {stub_responses: { head_object: {status_code: 404, headers: {}, body: '', }}}
-    subject.exists?.must_equal(false)
+    _(subject.exists?).must_equal(false)
   }
 
   describe 'when uploaded' do
@@ -23,8 +23,7 @@ describe Egads::S3Tarball do
     end
 
     it('should exist') do
-      subject.exists?.must_equal true
+      _(subject.exists?).must_equal true
     end
   end
 end
-

data/spec/egads_stage_spec.rb

@@ -4,6 +4,6 @@ describe "Egads::Stage" do
   subject { Egads::Stage }
 
   it 'should run the correct tasks' do
-  subject.commands.keys.must_equal %w(setup_environment extract run_before_hooks bundle symlink_system_paths symlink_config_files run_after_stage_hooks mark_as_staged)
+  _(subject.commands.keys).must_equal %w(setup_environment extract run_before_hooks bundle symlink_system_paths symlink_config_files run_after_stage_hooks mark_as_staged)
   end
 end

data/spec/egads_trim_spec.rb

@@ -4,6 +4,6 @@ describe "Egads::Trim" do
   subject { Egads::Trim }
 
   it 'should run the correct tasks' do
-  subject.commands.keys.must_equal %w(trim)
+  _(subject.commands.keys).must_equal %w(trim)
   end
 end

data/spec/egads_upload_spec.rb

@@ -4,6 +4,6 @@ describe "Egads::Upload" do
   subject { Egads::Upload }
 
   it 'should run the correct tasks' do
-    subject.commands.keys.must_equal %w(upload)
+    _(subject.commands.keys).must_equal %w(upload)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: egads
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Aaron Suggs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.4
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -66,10 +80,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2-
-
-      A collection of scripts for making a deployable tarball of a git commit,
-      uploading it to Amazon S3, and downloading it to your servers.
+description: |
+  A collection of scripts for making a deployable tarball of a git commit,
+  uploading it to Amazon S3, and downloading it to your servers.
 email:
 - aaron@ktheory.com
 executables:
@@ -78,12 +91,14 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/actions/setup-rubygems/action.yml"
+- ".github/workflows/test-release.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - Guardfile
 - README.md
 - Rakefile
+- Taskfile.yml
 - bin/egads
 - egads.gemspec
 - example/egads.yml
@@ -134,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: Extensible Git Archive Deploy Strategy

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-sudo: false # Opt-in to container infrastructure
-rvm:
-  - 2.5.5
-  - 2.6.3