discharger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48d8ec34c0e97892c1dd06c2a23e5d5f61028949d04638d848e62258c1c9f89c
+  data.tar.gz: d7a1d3338e2fe6bbbad2088e29017c1cefd6c5dac70b4dc45fc3f9429417f581
+SHA512:
+  metadata.gz: ab11db3d3ebfbaf567bafa691bf390a5c7b663f4d7b3d935e0996d057fe68472dc24e06b9b1c53fe1a41ec5de4007a78307c6243fff9f8eb9d71f22c86faf9f5
+  data.tar.gz: dc349824f12833069806e1b1a6fdad4fd1b17e53f349f155724a1c42a220500c6670cbcce43c90b64a331c6cd26cc804f1c84eeac5dd18bb04b656e6413cbaab

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 SOFware LLC
+
+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 the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Discharger
+Code supporting tasks that discharge code for deployment.
+
+## Usage
+
+Add `require "discharger/task"` to your Rakefile.
+
+Then build the discharger task
+
+```ruby
+require "discharger/task"
+
+Discharger::Task.create do |task|
+  task.version_file = "config/application.rb"
+  task.release_message_channel = "#some-slack-channel"
+  task.version_constant = "MyApp::VERSION"
+  task.app_name = "My App name"
+  task.commit_identifier = -> { `git rev-parse HEAD`.strip }
+  task.pull_request_url = "https://github.com/SOFware/some-app"
+end
+```
+
+It will make Rake tasks available to push code to branches and notify Slack channels.
+
+```bash
+$ rake -T release
+rake release                            # ---------- STEP 3 ----------
+rake release:build                      # Release the current version to stage
+rake release:prepare                    # ---------- STEP 1 ----------
+rake release:slack[text,channel,emoji]  # Send a message to Slack
+rake release:stage                      # ---------- STEP 2 ----------
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "discharger"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install discharger
+```
+
+## Contributing
+
+This gem is managed with [Reissue](https://github.com/SOFware/reissue).
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+task default: :test
+
+require "reissue/gem"
+
+Reissue::Task.create :reissue do |task|
+  task.version_file = "lib/discharger/version.rb"
+  task.commit = true
+end

data/lib/discharger/railtie.rb

@@ -0,0 +1,9 @@
+module Discharger
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      if ENV["SLACK_API_TOKEN_RELEASES"].nil?
+        raise "SLACK_API_TOKEN_RELEASES must be set in the environment"
+      end
+    end
+  end
+end

data/lib/discharger/task.rb

@@ -0,0 +1,299 @@
+require "rake/tasklib"
+
+module Discharger
+  class Task < Rake::TaskLib
+    def self.create(name = :release, &block)
+      task = new(name)
+      task.instance_eval(&block) if block
+      task.define
+      task
+    end
+
+    attr_accessor :name
+
+    attr_accessor :description
+
+    attr_accessor :working_branch
+    attr_accessor :staging_branch
+    attr_accessor :production_branch
+
+    attr_accessor :release_message_channel
+    attr_accessor :version_constant
+
+    attr_accessor :chat_token
+    attr_accessor :app_name
+    attr_accessor :commit_identifier
+    attr_accessor :pull_request_url
+
+    # Reissue settings
+    attr_accessor :version_file
+    attr_accessor :version_limit
+    attr_accessor :version_redo_proc
+    attr_accessor :changelog_file
+    attr_accessor :updated_paths
+    attr_accessor :commit
+    attr_accessor :commit_finalize
+
+    def initialize(name = :release)
+      @name = name
+      @working_branch = "develop"
+      @staging_branch = "stage"
+      @production_branch = "main"
+      @description = "Release the current version to #{staging_branch}"
+    end
+
+    # Run a multiple system commands and return true if all commands succeed
+    # If any command fails, the method will return false and stop executing
+    # any further commands.
+    #
+    # Provide a block to evaluate the output of the command and return true
+    # if the command was successful. If the block returns false, the method
+    # will return false and stop executing any further commands.
+    #
+    # @param *steps [Array<Array<String>>] an array of commands to run
+    # @param block [Proc] a block to evaluate the output of the command
+    # @return [Boolean] true if all commands succeed, false otherwise
+    #
+    # @example
+    #   syscall(
+    #     ["echo", "Hello, World!"],
+    #     ["ls", "-l"]
+    #   )
+    def syscall(*steps)
+      success = false
+      stdout, stderr, status = nil
+      steps.each do |*cmd|
+        puts cmd.join(" ").bg(:green).black
+        stdout, stderr, status = Open3.capture3(*cmd)
+        if status.success?
+          puts stdout
+        else
+          puts stderr
+          success = false
+          abort(stderr)
+        end
+      end
+      if block_given?
+        success = !!yield(stdout, stderr, status)
+        # If the error reports that a rule was bypassed, consider the command successful
+        # because we are bypassing the rule intentionally when merging the release branch
+        # to the production branch.
+        success = true if stderr.match?(/bypassed rule violations/i)
+        abort(stderr) unless success
+      end
+      success
+    end
+
+    # Echo a message to the console
+    #
+    # @param message [String] the message to echo
+    # return [TrueClass]
+    def sysecho(message)
+      system "echo", message
+      true
+    end
+
+    def define
+      require "slack-ruby-client"
+      Slack.configure do |config|
+        config.token = chat_token
+      end
+
+      desc <<~DESC
+        ---------- STEP 3 ----------
+        Release the current version to production
+
+        This task rebases the production branch on the staging branch and tags the
+        current version. The production branch and the tag will be pushed to the
+        remote repository.
+
+        After the release is complete, a new branch will be created to bump the
+        version for the next release.
+      DESC
+      task "#{name}": [:environment] do
+        current_version = Object.const_get(version_constant)
+        sysecho <<~MSG
+          Releasing version #{current_version} to production.
+
+          This will tag the current version and push it to the production branch.
+        MSG
+        sysecho "Are you ready to continue? (Press Enter to continue, Type 'x' and Enter to exit)".bg(:yellow).black
+        input = $stdin.gets
+        exit if input.chomp.match?(/^x/i)
+
+        continue = syscall(
+          "git checkout #{working_branch}",
+          "git branch -D #{staging_branch} 2> /dev/null || true",
+          "git branch -D #{production_branch} 2> /dev/null || true",
+          "git fetch origin #{staging_branch}:#{staging_branch} #{production_branch}:#{production_branch}",
+          "git checkout #{production_branch}",
+          "git rebase #{staging_branch}",
+          "git tag -a v#{current_version} -m 'Release #{current_version}'",
+          "git push origin #{production_branch}; git push origin v#{current_version}"
+        ) do
+          Rake::Task["slack"].invoke("Released #{Qualify.name} #{current_version} to production.", release_message_channel, ":chipmunk:")
+          syscall "git checkout #{working_branch}"
+        end
+
+        abort "Release failed." unless continue
+
+        sysecho <<~MSG
+          Version #{current_version} released to production.
+
+          Preparing to bump the version for the next release.
+
+        MSG
+
+        new_version_branch = "bump/begin-#{current_version.tr(".", "-")}"
+
+        continue = syscall("git checkout -b #{new_version_branch}") do
+          Rake::Task["reissue"].invoke
+        end
+
+        abort "Bump failed." unless continue
+
+        pr_url = "#{pull_request_url}/compare/#{working_branch}...#{new_version_branch}?expand=1&title=Begin%20#{current_version}"
+
+        syscall("git push origin #{new_version_branch} --force") do
+          sysecho <<~MSG
+            Branch #{new_version_branch} created.
+
+            Open a PR to #{working_branch} to mark the version and update the chaneglog
+            for the next release.
+
+            Opening PR: #{pr_url}
+          MSG
+        end.then do |success|
+          syscall "open #{pr_url}" if success
+        end
+      end
+
+      namespace name do
+        desc description
+        task build: :environment do
+          syscall(
+            "git fetch origin #{working_branch}",
+            "git checkout #{working_branch}",
+            "git branch -D #{staging_branch} 2> /dev/null || true",
+            "git checkout -b #{staging_branch}",
+            "git push origin #{staging_branch} --force"
+          ) do
+            Rake::Task["slack"].invoke("Building #{app_name} #{commit_identifier.call} on #{staging_branch}.", release_message_channel)
+            syscall "git checkout #{working_branch}"
+          end
+        end
+
+        desc "Send a message to Slack."
+        task :slack, [:text, :channel, :emoji] => :environment do |_, args|
+          args.with_defaults(
+            channel: release_message_channel,
+            emoji: nil
+          )
+          client = Slack::Web::Client.new
+          options = args.to_h
+          options[:icon_emoji] = options.delete(:emoji) if options[:emoji]
+
+          sysecho "Sending message to Slack:".bg(:green).black + " #{args[:text]}"
+          result = client.chat_postMessage(**options)
+          sysecho %(Message sent: #{result["ts"]})
+        end
+
+        desc <<~DESC
+          ---------- STEP 1 ----------
+          Prepare the current version for release to production (#{production_branch})
+
+          This task will create a new branch to prepare the release. The CHANGELOG
+          will be updated and the version will be bumped. The branch will be pushed
+          to the remote repository.
+
+          After the branch is created, open a PR to #{working_branch} to finalize
+          the release.
+        DESC
+        task prepare: [:environment] do
+          current_version = Object.const_get(version_constant)
+          finish_branch = "bump/finish-#{current_version.tr(".", "-")}"
+
+          syscall "git fetch origin #{working_branch}",
+            "git checkout #{working_branch}",
+            "git checkout -b #{finish_branch}"
+
+          sysecho <<~MSG
+            Branch #{finish_branch} created.
+
+            Check the contents of the CHANGELOG and ensure that the text is correct.
+
+            If you need to make changes, edit the CHANGELOG and save the file.
+            Then return here to continue with this commit.
+          MSG
+          sysecho "Are you ready to continue? (Press Enter to continue, Type 'x' and Enter to exit)".bg(:yellow).black
+          input = $stdin.gets
+          exit if input.chomp.match?(/^x/i)
+
+          Rake::Task["reissue:finalize"].invoke
+
+          params = {
+            expand: 1,
+            title: "Finish version #{current_version}",
+            body: <<~BODY
+              Completing development for #{current_version}.
+            BODY
+          }
+
+          pr_url = "#{pull_request_url}/compare/#{finish_branch}?#{params.to_query}"
+
+          continue = syscall "git push origin #{finish_branch} --force" do
+            sysecho <<~MSG
+              Branch #{finish_branch} created.
+              Open a PR to #{working_branch} to finalize the release.
+
+              #{pr_url}
+
+              Once the PR is merged, pull down #{working_branch} and run
+                'rake #{name}:stage'
+              to stage the release branch.
+            MSG
+          end
+          if continue
+            syscall "git checkout #{working_branch}",
+              "open #{pr_url}"
+          end
+        end
+
+        desc <<~DESC
+          ---------- STEP 2 ----------
+          Stage the release branch
+
+          This task will update Stage, open a PR, and instruct you on the next steps.
+
+          NOTE: If you just want to update the stage environment but aren't ready to release, run:
+
+              bin/rails #{name}:build
+        DESC
+        task stage: [:environment] do
+          Rake::Task["build"].invoke
+          current_version = Object.const_get(version_constant)
+
+          params = {
+            expand: 1,
+            title: "Release #{current_version} to production",
+            body: <<~BODY
+              Deploy #{current_version} to production.
+            BODY
+          }
+
+          pr_url = "#{pull_request_url}/compare/#{production_branch}...#{staging_branch}?#{params.to_query}"
+
+          sysecho <<~MSG
+            Branch #{staging_branch} updated.
+            Open a PR to #{production_branch} to release the version.
+
+            Opening PR: #{pr_url}
+
+            Once the PR is **approved**, run 'rake release' to release the version.
+          MSG
+          syscall "open #{pr_url}"
+        end
+      end
+    end
+  end
+end

data/lib/discharger/version.rb

@@ -0,0 +1,3 @@
+module Discharger
+  VERSION = "0.1.0"
+end

data/lib/discharger.rb

@@ -0,0 +1,5 @@
+require "discharger/version"
+require "discharger/railtie"
+
+module Discharger
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: discharger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Gay
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.1
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reissue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Code supporting deployments.
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/discharger.rb
+- lib/discharger/railtie.rb
+- lib/discharger/task.rb
+- lib/discharger/version.rb
+homepage: https://github.com/SOFware/discharger
+licenses: []
+metadata:
+  homepage_uri: https://github.com/SOFware/discharger
+  source_code_uri: https://github.com/SOFware/discharger.git
+  changelog_uri: https://github.com/SOFware/discharger/blob/main/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: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Tasks for discharging an application for deployment.
+test_files: []