Tag changes

.github/workflows/ruby.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
 
     steps:
     - uses: actions/checkout@v2

README.md

@@ -12,14 +12,23 @@ This gem provides a convenient interface for creating releases and deploying usi
 
 ## Installation
 
+At the top of your application's `Gemfile` add this line if it does not already exist:
+
+```sh
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+```
+
 Add this line to your application's Gemfile:
 
-    gem 'epi_deploy', github: 'epigenesys/epi_deploy'
+```rb
+gem 'epi_deploy', github: 'epigenesys/epi_deploy'
+```
 
 And then execute:
 
-    $ bundle install
-
+```sh
+$ bundle install
+```
 
 ## Usage
 
@@ -101,10 +110,41 @@ You can also deploy to all customers for a given environment by running e.g. `ca
 
 Using branches for stages, i.e. demo and production branches, can clutter up your branches screen. This can be particularly awkward when running CI and keeping track of multiple active branches. To resolve this you can optionally configure epi_deploy to use tags for this instead of branches.
 
-1. Update to epi_deploy 2.2.0 or greater.
-2. Add config/epi_deploy.rb to your application.
-3. Add `EpiDeploy.use_tags_for_deploy = true` to the newly created config file.
-4. Delete your stage branches on gitlab (likely `production`, `demo`, `qa`).
-5. Push your changes and deploy to a demo site to test it is working correctly.
+Tags will be automatically created for each successful deployment with the format `environment.stage-timestamp`, for example `production.epigenesys-2024_10_03-12_20_09`, and pushed to the remote.
+
+1. Change the line in your Gemfile to this, to ensure that you have version 2.3 or greater.
+
+   ```rb
+   gem 'epi_deploy', '>= 2.3', github: 'epigenesys/epi_deploy'
+   ```
+
+1. Update epi_deploy in your application's gems
+
+   ```sh
+   bundle update epi_deploy
+   ```
+
+1. Create a file called `config/epi_deploy.rb` if it does not already exist, with this configuration option:
+
+   ```rb
+   EpiDeploy.use_timestamped_deploy_tags = true
+   ```
+
+1. If it hasn't be added already, add this line to `Capfile`
+
+   ```rb
+   require 'capistrano/epi_deploy'
+   ```
+
+1. Commit and push your changes, then deploy to a demo site to test it is working correctly.
+
+If you've previously used the `use_tags_for_deploy` configuration option, then this has now been removed since v2.3. If you upgrade to v2.3, then you should remove the old deployment tags manually from your local repo and remotely by doing, e.g.
+
+```sh
+git tag --delete production demo
+git push origin --delete production demo
+```
+
+and remove the old `EpiDeploy.use_tags_for_deploy` from your application's `config/epi_deploy.rb` file.
 
-Note: In the future we intend to change this configuration option to default to true.
+You can then use the deployment branches (the default behaviour) or the new tags for deployment.

bin/ed

@@ -1,45 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'slop'
-require_relative '../lib/epi_deploy/command'
+require_relative '../lib/epi_deploy/cli'
 
-config_path = File.join(Dir.pwd, 'config/epi_deploy.rb')
-if File.exist?(config_path)
-  require config_path
-end
-
-begin
-  opts = Slop.parse strict: true do
-
-    banner 'Usage: bundle exec epi_deploy <command>'
-
-    command 'release' do
-      description 'Create a new release with optional deploy'
-
-      on :d=, :deploy=, 'Deploy to specified environment(s)', argument: :optional, as: Array, delimiter: ':'
-
-      run do |options, args|
-        command = EpiDeploy::Command.new(options, args)
-        command.release
-      end
-    end
-
-    command 'deploy' do
-      description 'Deploys an existing release'
-
-      on :r=, :ref=, 'Git reference to deploy', argument: :optional
-
-      run do |options, args|
-        command = EpiDeploy::Command.new(options, args)
-        command.deploy
-      end
-    end
-
-    run do |options, args|
-      Kernel.abort "\x1B[31mValid commands are 'release' and 'deploy'.\x1B[0m"
-    end
-
-  end
-rescue Slop::InvalidOptionError, Slop::InvalidArgumentError, RuntimeError => e
-  Kernel.abort "\x1B[31m#{e.message}\x1B[0m"
-end
+EpiDeploy::Cli.new.run!

bin/epi_deploy

@@ -1,45 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'slop'
-require_relative '../lib/epi_deploy/command'
+require_relative '../lib/epi_deploy/cli'
 
-config_path = File.join(Dir.pwd, 'config/epi_deploy.rb')
-if File.exist?(config_path)
-  require config_path
-end
-
-begin
-  opts = Slop.parse strict: true do
-
-    banner 'Usage: bundle exec epi_deploy <command>'
-
-    command 'release' do
-      description 'Create a new release with optional deploy'
-
-      on :d=, :deploy=, 'Deploy to specified environment(s)', argument: :optional, as: Array, delimiter: ':'
-
-      run do |options, args|
-        command = EpiDeploy::Command.new(options, args)
-        command.release
-      end
-    end
-
-    command 'deploy' do
-      description 'Deploys an existing release'
-
-      on :r=, :ref=, 'Git reference to deploy', argument: :optional
-
-      run do |options, args|
-        command = EpiDeploy::Command.new(options, args)
-        command.deploy
-      end
-    end
-
-    run do |options, args|
-      Kernel.abort "\x1B[31mValid commands are 'release' and 'deploy'.\x1B[0m"
-    end
-
-  end
-rescue Slop::InvalidOptionError, Slop::InvalidArgumentError, RuntimeError => e
-  Kernel.abort "\x1B[31m#{e.message}\x1B[0m"
-end
+EpiDeploy::Cli.new.run!

epi_deploy.gemspec

@@ -6,8 +6,8 @@ require 'epi_deploy/version'
 Gem::Specification.new do |gem|
   gem.name          = "epi_deploy"
   gem.version       = EpiDeploy::VERSION
-  gem.authors       = ["Anthony Nettleship", "Shuo Chen", "Chris Hunt", "James Gregory"]
-  gem.email         = ["[email protected]", "[email protected]", "[email protected]", "[email protected]"]
+  gem.authors       = ["Anthony Nettleship", "Shuo Chen", "Chris Hunt", "James Gregory", "William Lee"]
+  gem.email         = ["[email protected]", "[email protected]", "[email protected]", "[email protected]", "[email protected]"]
   gem.description   = "A gem to facilitate deployment across multiple git branches and evironments"
   gem.summary       = "eD"
   gem.homepage      = "https://www.epigenesys.org.uk"

lib/capistrano/epi_deploy.rb

@@ -1 +1 @@
-load File.join(File.dirname(__FILE__), 'tasks', 'multi_customers.rb')
+Dir.glob(File.join(File.dirname(__FILE__), 'tasks', '*.rb')).each { |f| require f }

lib/capistrano/tasks/branches.rb

@@ -0,0 +1,25 @@
+require_relative '../../epi_deploy/config'
+
+Dir["config/initializers/version.rb", "config/epi_deploy.rb"].each do |file|
+  require File.join(Dir.pwd, file)
+end
+
+if EpiDeploy.use_timestamped_deploy_tags
+  namespace :epi_deploy do
+    task :set_branch do
+      branch = if ENV['BRANCH']
+        ENV['BRANCH']
+      elsif Object.const_defined?('LATEST_RELEASE_TAG')
+        LATEST_RELEASE_TAG
+      end
+
+      if branch.nil?
+        raise 'Cannot determine commit to deploy as BRANCH environment variable is not set and LATEST_RELEASE_TAG constant in version.rb could not be found'
+      end
+
+      set :branch, branch
+    end
+  end
+
+  before 'deploy:starting', 'epi_deploy:set_branch'
+end

lib/capistrano/tasks/multi_customers.rb

@@ -1,7 +1,10 @@
 namespace :epi_deploy do
   task :symlink_customer_configs do
     on release_roles :all  do
-      execute :ln, '-s', release_path.join("config/customers/customer_settings/#{fetch(:current_customer)}.yml"), release_path.join("config/customer_settings.yml")
+      customer_settings_path = release_path.join("config/customers/customer_settings/#{fetch(:current_customer)}.yml")
+      if test("[ -f #{customer_settings_path}]")
+        execute :ln, '-s', customer_settings_path, release_path.join("config/customer_settings.yml")
+      end
     end
   end
 end

lib/epi_deploy/app_version.rb

@@ -1,38 +1,56 @@
 module EpiDeploy
   class AppVersion
-    attr_reader :version_file_path
+    attr_accessor :version_file_path, :version, :latest_release_tag
 
     def initialize(current_dir = Dir.pwd)
-      @version_file_path = File.join(current_dir, 'config/initializers/version.rb')
+      self.version_file_path = File.join(current_dir, 'config/initializers/version.rb')
     end
-
-    def initial_version_file_if_required
-      self.version = 0 unless version_file_exists?
-    end
-
-    def bump!
-      self.version = version + 1
-    end
-
-    def version
-      @version ||= extract_version_number
+
+    def load
+      if version_file_exists?
+        File.open(version_file_path) do |f|
+          contents = f.read
+          self.version = extract_version_number(contents)
+          self.latest_release_tag = extract_latest_release_tag(contents)
+        end
+      else
+        self.version = 0
+        self.latest_release_tag = ''
+      end
     end
-    
-    def version=(new_version)
+
+    def save!
       File.open version_file_path, 'w' do |f|
-        f.write "APP_VERSION = '#{new_version}'"
+        f.write "APP_VERSION = '#{version}'\n"
+        f.write "LATEST_RELEASE_TAG = '#{latest_release_tag}'\n"
       end
-      @version = extract_version_number
     end
-
+
+    def bump
+      self.version += 1
+    end
+
+    def self.open(current_dir = Dir.pwd)
+      app_version = self.new(current_dir)
+      app_version.load
+      app_version
+    end
+
     private
       def version_file_exists?
         File.exist? version_file_path
       end
 
-      def extract_version_number
-        return 0 unless version_file_exists?
-        File.read(version_file_path).match(/APP_VERSION = '(?<version>\d+).*'/)[:version].to_i
+      def extract_version_number(contents)
+        contents.match(/APP_VERSION\s*=\s*'(?<version>\d+).*'/)[:version].to_i
+      end
+
+      def extract_latest_release_tag(contents)
+        if (match = contents.match(/LATEST_RELEASE_TAG\s*=\s*'(?<tag>[A-Za-z0-9_-]+)'/))
+          match[:tag]
+        else
+          ''
+        end
       end
 
   end

lib/epi_deploy/cli.rb

@@ -0,0 +1,54 @@
+require 'slop'
+
+require_relative 'command'
+
+module EpiDeploy
+  class Cli
+    def run!
+      load_config
+
+      Slop.parse strict: true do
+
+        banner 'Usage: bundle exec epi_deploy <command>'
+
+        command 'release' do
+          description 'Create a new release with optional deploy'
+
+          on :d=, :deploy=, 'Deploy to specified environment(s)', argument: :optional, as: Array, delimiter: ':'
+
+          run do |options, args|
+            command = EpiDeploy::Command.new(options, args)
+            command.release
+          end
+        end
+
+        command 'deploy' do
+          description 'Deploys an existing release'
+
+          on :r=, :ref=, 'Git reference to deploy', argument: :optional
+
+          run do |options, args|
+            command = EpiDeploy::Command.new(options, args)
+            command.deploy
+          end
+        end
+
+        run do |options, args|
+          Kernel.abort "\x1B[31mValid commands are 'release' and 'deploy'.\x1B[0m"
+        end
+
+      end
+    rescue Slop::InvalidOptionError, Slop::InvalidArgumentError, RuntimeError => e
+      Kernel.abort "\x1B[31m#{e.message}\x1B[0m"
+    end
+
+    private
+
+      def load_config
+        config_path = File.join(Dir.pwd, 'config/epi_deploy.rb')
+        if File.exist?(config_path)
+          require config_path
+        end
+      end
+  end
+end