discharger 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86a58f41a34e61bfc155a9563e55bbc1eb42d4bd6904c09fe4aafb9bc61f3411
-  data.tar.gz: 62d3b3ad5ffec0dcdee073f5ca0109416b383dd2fe180f8501af47f2028d9122
+  metadata.gz: 22ff9b0cc383ea213a6a8766f713ef4afa97a114c679c76b37954f73872b74e3
+  data.tar.gz: a3cfa43c5c9665704e13bce7a3bb19e36ccd4810b700b149a2646815fcca9f6a
 SHA512:
-  metadata.gz: d0f6c58d5fde62fb7dd63b5dbe56c867600eea46e5c8e74b9eee22025da5dd299bf9d0b1093a40a67411c5cc279b9ca826e0c6d0af8659635fb6692279fa8fab
-  data.tar.gz: 4ef09b9ca157755c99aa693d3c768e11df6f4fb470ed2d3c4736cf7c2fb894fb46352e941e550c2c200ec95bfd98f40a5daf22ca0928431231fdad04e07fe1ca
+  metadata.gz: 0e01ea39ed9eba5c973951784d44b5488a1f6f00effc59a1192d5f1f3cfd2aafbe14895a1d6ce920520acb7c501bc79720febc7360bed35a301c742ab30728ad
+  data.tar.gz: 309f1fd0b7ea3d78814aedd8c8bb945e0c63806260007dc8391126863254d4f19d87adc0e9ec7cdd584c3173982fd69465e87c06a13a97f90870aa60d93b2f6d

data/CHANGELOG.md

@@ -5,14 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.3.1] - 2026-05-13
+## [0.3.3] - 2026-07-22
 
 ### Added
 
-- database.prefer_docker setup.yml option for explicit Docker vs native PostgreSQL selection (2fca81e)
+- Post-release runbook announcement in the Slack release thread, from Reissue's runbook_file (0cf9620)
 
-## [0.2.31] - 2026-04-09
+## [0.3.2] - 2026-07-15
 
-### Added
+### Changed
+
+- Treat generated pg_tools setup as opt-in for apps that use structure.sql or PostgreSQL CLI workflows.
+
+### Fixed
 
-- Unified setup entry point with pre-steps support (1459633)
+- Retry `brew bundle` once before failing setup, so transient Homebrew lock contention (e.g. two `bin/setup` runs on the same host) doesn't hard-fail the whole run.
+- pg-tools wrappers no longer forward localhost -h/-p flags into docker exec, where the host-mapped port doesn't exist; remote hosts still pass through untouched (a3869d2)

data/README.md

@@ -89,6 +89,51 @@ changelog.d/
 
 Each fragment file should contain the changelog entry for a specific change or feature.
 
+### Post-release Runbook
+
+Some releases need manual follow-up: run a rake task, backfill data, re-index documents.
+Reissue collects those steps from `Runbook:` commit trailers, and Discharger announces
+them to your team in the release thread.
+
+```ruby
+Discharger::Task.create do |task|
+  # ... other configuration ...
+  task.runbook_file = "RUNBOOK.md"  # Default: nil (disabled)
+end
+```
+
+Add steps as you work, in the same commit as the change that requires them:
+
+```bash
+git commit -m "Add data migration
+
+Fixed: Duplicate user records
+Runbook: Run \`rake data:cleanup\` after deploy"
+```
+
+`rake release:prepare` finalizes the runbook alongside the changelog, so the release tag
+records exactly which steps that version needs. After the production release, Discharger
+posts the checklist to Slack as a reply in the release thread, right after the changelog:
+
+```
+*Post-release runbook for 1.2.3* — 2 steps
+
+• Run `rake data:cleanup` (abc1234)
+• Re-index search documents (def5678)
+```
+
+When a release needs no follow-up, the thread says so explicitly rather than staying
+silent, so nobody has to wonder whether the check was skipped:
+
+```
+*Post-release runbook for 1.2.3*
+No runbook tasks for this release.
+```
+
+Leave `runbook_file` unset and Discharger posts nothing extra. See the
+[Reissue runbook documentation](https://github.com/SOFware/reissue#post-release-runbook)
+for how items are collected and merged.
+
 ## Available Tasks
 
 The gem creates several Rake tasks for managing your deployment workflow:
@@ -199,12 +244,12 @@ The `pre_steps` array defines commands that run **before Rails loads**. These ar
 
 Built-in pre_steps:
 - `homebrew` - Installs Homebrew if not present (macOS)
-- `postgresql_tools` - Installs PostgreSQL client tools (`pg_dump`, `psql`)
+- `postgresql_tools` - Optionally installs PostgreSQL client tools (`pg_dump`, `psql`) for apps that use `structure.sql` or call those tools directly
 
 ```yaml
 pre_steps:
   - homebrew
-  - postgresql_tools
+  # - postgresql_tools
 ```
 
 You can also define custom pre_steps with shell commands:
@@ -228,6 +273,7 @@ The `steps` array specifies which built-in setup commands to run. Available comm
 - `yarn` - Install JavaScript packages
 - `config` - Copy configuration files
 - `docker` - Setup Docker containers
+- `pg_tools` - Create Docker-aware `pg_dump` and `psql` wrappers for apps that use `structure.sql` or call those tools directly
 - `env` - Configure environment variables
 - `database` - Setup and migrate database
 

data/lib/discharger/setup_runner/commands/brew_command.rb

@@ -6,10 +6,12 @@ module Discharger
   module SetupRunner
     module Commands
       class BrewCommand < BaseCommand
+        RETRY_DELAY_SECONDS = 2
+
         def execute
           proceed_with "brew bundle" do
             log "Ensuring brew dependencies"
-            system! "brew bundle"
+            run_brew_bundle
           end
         end
 
@@ -20,6 +22,23 @@ module Discharger
         def description
           "Install Homebrew dependencies"
         end
+
+        private
+
+        # brew bundle can fail transiently (e.g. Homebrew lock contention from a
+        # concurrent `brew` invocation) unrelated to the app's actual dependencies.
+        # Retry once before treating it as a real setup failure.
+        def run_brew_bundle
+          system! "brew bundle"
+        rescue => e
+          log "brew bundle failed, retrying once: #{e.message}"
+          sleep retry_delay
+          system! "brew bundle"
+        end
+
+        def retry_delay
+          RETRY_DELAY_SECONDS
+        end
       end
     end
   end

data/lib/discharger/setup_runner/commands/pg_tools_command.rb

@@ -62,6 +62,8 @@ module Discharger
               # When running in Docker, we need to output to stdout and redirect locally
               OUTPUT_FILE=""
               HAS_USER=""
+              HOST=""
+              PORT=""
               ARGS=()
               while [[ $# -gt 0 ]]; do
                 case $1 in
@@ -82,6 +84,38 @@ module Discharger
                     ARGS+=("$1")
                     shift
                     ;;
+                  -h|--host)
+                    if [[ $# -lt 2 ]]; then
+                      echo "Error: $1 requires an argument" >&2
+                      exit 2
+                    fi
+                    HOST="$2"
+                    shift 2
+                    ;;
+                  -h?*)
+                    HOST="${1#-h}"
+                    shift
+                    ;;
+                  --host=*)
+                    HOST="${1#*=}"
+                    shift
+                    ;;
+                  -p|--port)
+                    if [[ $# -lt 2 ]]; then
+                      echo "Error: $1 requires an argument" >&2
+                      exit 2
+                    fi
+                    PORT="$2"
+                    shift 2
+                    ;;
+                  -p?*)
+                    PORT="${1#-p}"
+                    shift
+                    ;;
+                  --port=*)
+                    PORT="${1#*=}"
+                    shift
+                    ;;
                   *)
                     ARGS+=("$1")
                     shift
@@ -94,6 +128,19 @@ module Discharger
                 ARGS=("-U" "postgres" "${ARGS[@]}")
               fi
 
+              # Drop localhost host/port flags: they target the host-mapped
+              # port, but inside the container Postgres listens on its default
+              # port. Remote hosts pass through untouched.
+              case "$HOST" in
+                ""|localhost|127.0.0.1|::1) ;;
+                *)
+                  ARGS+=("-h" "$HOST")
+                  if [[ -n "$PORT" ]]; then
+                    ARGS+=("-p" "$PORT")
+                  fi
+                  ;;
+              esac
+
               if [[ -n "$OUTPUT_FILE" ]]; then
                 # Run pg_dump in container, output to stdout, redirect to local file
                 docker exec -i "$CONTAINER" pg_dump "${ARGS[@]}" > "$OUTPUT_FILE"
@@ -133,6 +180,8 @@ module Discharger
               # so we pipe file content via stdin instead
               INPUT_FILE=""
               HAS_USER=""
+              HOST=""
+              PORT=""
               ARGS=()
               while [[ $# -gt 0 ]]; do
                 case $1 in
@@ -153,6 +202,38 @@ module Discharger
                     ARGS+=("$1")
                     shift
                     ;;
+                  -h|--host)
+                    if [[ $# -lt 2 ]]; then
+                      echo "Error: $1 requires an argument" >&2
+                      exit 2
+                    fi
+                    HOST="$2"
+                    shift 2
+                    ;;
+                  -h?*)
+                    HOST="${1#-h}"
+                    shift
+                    ;;
+                  --host=*)
+                    HOST="${1#*=}"
+                    shift
+                    ;;
+                  -p|--port)
+                    if [[ $# -lt 2 ]]; then
+                      echo "Error: $1 requires an argument" >&2
+                      exit 2
+                    fi
+                    PORT="$2"
+                    shift 2
+                    ;;
+                  -p?*)
+                    PORT="${1#-p}"
+                    shift
+                    ;;
+                  --port=*)
+                    PORT="${1#*=}"
+                    shift
+                    ;;
                   *)
                     ARGS+=("$1")
                     shift
@@ -165,6 +246,19 @@ module Discharger
                 ARGS=("-U" "postgres" "${ARGS[@]}")
               fi
 
+              # Drop localhost host/port flags: they target the host-mapped
+              # port, but inside the container Postgres listens on its default
+              # port. Remote hosts pass through untouched.
+              case "$HOST" in
+                ""|localhost|127.0.0.1|::1) ;;
+                *)
+                  ARGS+=("-h" "$HOST")
+                  if [[ -n "$PORT" ]]; then
+                    ARGS+=("-p" "$PORT")
+                  fi
+                  ;;
+              esac
+
               if [[ -n "$INPUT_FILE" ]]; then
                 docker exec -i "$CONTAINER" #{tool} "${ARGS[@]}" < "$INPUT_FILE"
               else

data/lib/discharger/setup_runner/prerequisites_loader.rb

@@ -55,14 +55,36 @@ module Discharger
       def set_db_port(db_config)
         if db_config["port"] && !ENV["DB_PORT"]
           ENV["DB_PORT"] = db_config["port"].to_s
-          ENV["PGPORT"] = db_config["port"].to_s
+          set_pgport_if_needed(db_config["port"].to_s)
           puts "  Setting DB_PORT=#{db_config["port"]} from config/setup.yml"
         elsif ENV["DB_PORT"]
           warn_if_mismatch("DB_PORT", ENV["DB_PORT"], db_config["port"].to_s)
-          ENV["PGPORT"] = ENV["DB_PORT"]
+          set_pgport_if_needed(ENV["DB_PORT"])
         end
       end
 
+      def set_pgport_if_needed(port)
+        ENV["PGPORT"] = port if postgresql_cli_setup_enabled?
+      end
+
+      def postgresql_cli_setup_enabled?
+        configured_pre_steps.include?("postgresql_tools") ||
+          configured_steps.include?("pg_tools") ||
+          all_regular_steps_enabled?
+      end
+
+      def configured_pre_steps
+        Array(config["pre_steps"]).select { |step| step.is_a?(String) }
+      end
+
+      def configured_steps
+        Array(config["steps"]).select { |step| step.is_a?(String) }
+      end
+
+      def all_regular_steps_enabled?
+        !config.key?("steps") || Array(config["steps"]).empty?
+      end
+
       def set_db_name(db_config)
         if db_config["name"] && !ENV["DB_NAME"]
           container_name = db_config["name"].to_s

data/lib/discharger/task.rb

@@ -24,6 +24,7 @@ module Discharger
         reissue.fragment = task.fragment
         reissue.clear_fragments = task.clear_fragments
         reissue.tag_pattern = task.tag_pattern
+        reissue.runbook_file = task.runbook_file
       end
       task.define
       task
@@ -179,6 +180,27 @@ module Discharger
       stdout.strip
     end
 
+    # The post-release steps collected from "Runbook:" commit trailers.
+    # Empty when no runbook is configured or the file has yet to be written.
+    def runbook_items
+      return [] unless runbook_file
+
+      Reissue::Runbook.new(Rails.root.join(runbook_file).to_s).items
+    end
+
+    # Build the Slack message listing the post-release steps for a version.
+    # Returns nil when the project does not use a runbook, which is distinct
+    # from a configured runbook that happens to have no steps this release.
+    def runbook_announcement(version, items = runbook_items)
+      return nil unless runbook_file
+
+      header = "*Post-release runbook for #{version}*"
+      return "#{header}\nNo runbook tasks for this release." if items.empty?
+
+      "#{header} — #{items.size} step#{"s" unless items.size == 1}\n\n" +
+        items.map { |item| "• #{item}" }.join("\n")
+    end
+
     def existing_pr_number(base, head)
       stdout, _, status = Open3.capture3(
         "gh", "pr", "list",
@@ -286,10 +308,17 @@ module Discharger
           ["git push origin v#{current_version}"]
         ) do
           tasker["#{name}:slack"].invoke("Released #{app_name} #{current_version} (#{commit_identifier.call}) to production.", release_message_channel, ":chipmunk:")
-          if last_message_ts.present?
+          # Capture the root before replying; each post overwrites last_message_ts.
+          thread_ts = last_message_ts
+          if thread_ts.present?
             text = File.read(Rails.root.join(changelog_file))
             tasker["#{name}:slack"].reenable
-            tasker["#{name}:slack"].invoke(text, release_message_channel, ":log:", last_message_ts)
+            tasker["#{name}:slack"].invoke(text, release_message_channel, ":log:", thread_ts)
+
+            if (runbook_message = runbook_announcement(current_version))
+              tasker["#{name}:slack"].reenable
+              tasker["#{name}:slack"].invoke(runbook_message, release_message_channel, ":clipboard:", thread_ts)
+            end
           end
           # Signal success — no branch switch needed since we stay on working_branch throughout
           true

data/lib/discharger/version.rb

@@ -1,3 +1,3 @@
 module Discharger
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

data/lib/generators/discharger/install/templates/setup.yml

@@ -24,7 +24,7 @@ redis:
 #
 # Built-in pre_steps:
 #   - homebrew         # Installs Homebrew if not present
-#   - postgresql_tools # Installs PostgreSQL client tools (pg_dump, psql)
+#   - postgresql_tools # Optional: installs PostgreSQL client tools for structure.sql workflows
 #
 # Custom pre_steps (run shell commands):
 #   - description: "Description of step"
@@ -33,7 +33,7 @@ redis:
 #
 pre_steps: []
   # - homebrew
-  # - postgresql_tools
+  # - postgresql_tools # Optional: for apps that use structure.sql or pg_dump/psql directly
 
 # Built-in commands to run (empty array runs all available commands)
 # Available commands: brew, asdf, git, bundler, yarn, config, docker, pg_tools, env, database
@@ -45,10 +45,12 @@ steps:
   - yarn
   - config
   - docker
-  - pg_tools
   - env
   - database
 
+# Optional for apps that use structure.sql or other pg_dump/psql workflows:
+#   - pg_tools
+
 # Custom commands for application-specific setup (run AFTER Rails loads)
 custom_steps:
   - description: "Seed application data"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discharger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Jim Gay
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
   requirement: !ruby/object:Gem::Requirement