discharger 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b0eda964739589ae49d73ea992ff80d8e782b3de287ca19fcb1a82c605d1638
-  data.tar.gz: 5d86440df15d87cb9a66b5133dc1d70d8f736bd0644a7b9f57b5a4d2a3428e89
+  metadata.gz: '0438319d582d725e71df1e9fdaf270f8036bc78f1f3c8c01b0bd4038d251e981'
+  data.tar.gz: 862ac9091b25ac1a179768f251db61a8aa2b9bcd9b6b1be6848aeb41e8687d66
 SHA512:
-  metadata.gz: 82c6912aee9e99edeb92304f26a0443983495b4aa8b3152cea7497da0da895ad892b8d392bdd25d7a1d559176c6a412589fd9b2dab0bc8fae9fb1c28019602ad
-  data.tar.gz: 48a5949f5177ace0de43d0788ce3f45a6dd24b558478704014b5234c6625e23737c209f831550ed224c1ca6b6869f08d0fdb8c30515f1af6efebafeb129c80db
+  metadata.gz: c237780b6041dd817e2d3c8e48ee0eebd98e8af7103c91c52d4725c0436c37c3312b7acdb60c70fcd86b660a18086cebd4ff24746921d6eb75a010f896e307b3
+  data.tar.gz: 89dd92c5c832f9cee93ae0866711ad0b8989c0c6eade619e14eccff38db6e9740bdad00a97779809b5695c4f5d55763e504422858f8f0f5c7bc1d0279712448d

data/CHANGELOG.md

@@ -5,24 +5,33 @@ 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.4.0] - 2026-09-24
+## [0.4.2] - 2026-09-30
 
 ### Added
 
-- pr_label option opening the finalize and version-bump PRs via gh with that label (08e1d10)
-
-### Changed
-
-- Auto-deploy releases tag the newest commit that changed the version's changelog section instead of requiring it at HEAD, and no longer open a production PR (476fe1b)
-- Auto-deploy releases merge the release tag into the production branch (a7a1b49)
+- database.db_name in setup.yml sets the exported DB_NAME, or false leaves it to database.yml (836e811)
 
 ### Fixed
 
-- retain_changelogs reaches Reissue, so finalize writes the archived changelog file (2a90edf)
-- release:prepare branches from origin, so a stale local branch no longer yields an empty changelog (8eb5fd3)
+- The generated bin/setup stores a gh token only after the GitHub Packages source accepts it (1ef5a44)
 
-## [0.3.5] - 2026-08-10
+## [0.4.1] - 2026-09-29
 
 ### Added
 
-- github_packages setup step storing bundler credentials for a private GitHub Packages gem source via the gh CLI (2cff4b6)
+- Setup prints each step's elapsed time and the total (063521c)
+- bin/setup opens with a do-not-edit notice, and `discharger:install --setup-only` regenerates only the script (71ee122)
+
+### Changed
+
+- Gem author listed as Savannah Albanez (a48c8d8)
+
+### Removed
+
+- Stale Qualify setup script from the repo root, never shipped in the gem (8744c43)
+
+### Fixed
+
+- Releases finish when the Slack token is missing or the post fails (3cf9b6d)
+- bin/setup bootstraps a fresh clone: GitHub Packages credentials, bundle install, then re-exec under bundle exec (7196fe4)
+- github_packages stores bundler credentials only after the source accepts them (41fab0f)

data/README.md

@@ -209,7 +209,34 @@ After installing Discharger, run the setup script to configure your development
 $ bin/setup
 ```
 
-This script is idempotent - you can run it multiple times safely, and it will ensure your environment is properly configured.
+You can rerun it whenever your environment drifts. Every run drops and rebuilds the development and test databases, so local data is lost.
+
+It works on a fresh clone with no gems installed. The generated script first runs a
+standard-library-only pass that stores bundler credentials for a configured
+`github_packages` source (from your GitHub CLI login, only once the source
+accepts that token), installs the bundle, and then
+re-execs itself under `bundle exec` so default gems such as psych never clash with
+`Gemfile.lock`. The `DISCHARGER_SETUP_BUNDLED` environment variable marks the second
+pass; the `github_packages` step later verifies the stored credentials and warns when
+the token lacks the `read:packages` scope. Rails still has to boot before the steps
+run, so an app whose boot needs `.env` or `config/database.yml` copies them in
+`pre_steps` (see below).
+
+Each step prints its elapsed time when it finishes, and the closing line reports the
+total, so a slow setup shows which step to look at.
+
+### Keeping bin/setup Generated
+
+`bin/setup` is a verbatim copy of the gem's template and opens with a notice saying
+so. Do not hand-edit it in an app: app-specific work belongs in `config/setup.yml`
+(`pre_steps`, `steps`, `custom_steps`), and changes to the script itself belong in
+this gem's template so every app picks them up. After bumping to a discharger
+release that changed the template, regenerate the script without touching
+`config/setup.yml` or the initializer:
+
+```bash
+$ bin/rails generate discharger:install --setup-only --force
+```
 
 ### Configuration
 
@@ -223,6 +250,9 @@ database:
   name: "db-your-app"
   version: "14"
   password: "postgres"
+  # Optional. DB_NAME exported before Rails boots; defaults to the container
+  # name without "db-". false leaves it to database.yml.
+  # db_name: "your-app"
   # Optional. Controls how the docker step handles a native PostgreSQL
   # already listening on the configured port:
   #   omitted/nil/false - silently skip Docker and use the native instance (legacy default)
@@ -291,7 +321,7 @@ The `steps` array specifies which built-in setup commands to run. Available comm
 - `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
+- `database` - Drop and recreate the development and test databases, load the schema, migrate, and seed. Every run resets local data.
 
 ### Selecting Specific Steps
 

data/lib/discharger/setup.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "fileutils"
-require "pathname"
+require_relative "timing"
 
 # Unified entry point for Discharger setup.
 # Handles both pre-Rails prerequisites and post-Rails setup commands.
@@ -34,21 +34,23 @@ module Discharger
         validate_environment
         print_header
 
-        # Phase 1: Load bundler first (activates correct gem versions)
-        # This must happen before we parse YAML to avoid psych version conflicts
-        load_bundler
+        elapsed = Timing.measure do
+          # Phase 1: Load bundler first (activates correct gem versions)
+          # This must happen before we parse YAML to avoid psych version conflicts
+          load_bundler
 
-        # Phase 2: Pre-Rails setup (env vars, system dependencies)
-        # These run AFTER bundler but BEFORE Rails loads
-        run_prerequisites
+          # Phase 2: Pre-Rails setup (env vars, system dependencies)
+          # These run AFTER bundler but BEFORE Rails loads
+          run_prerequisites
 
-        # Phase 3: Load Rails (uses env vars from phase 2)
-        load_rails
+          # Phase 3: Load Rails (uses env vars from phase 2)
+          load_rails
 
-        # Phase 4: Run Discharger commands (after Rails loads)
-        run_setup_commands
+          # Phase 4: Run Discharger commands (after Rails loads)
+          run_setup_commands
+        end
 
-        print_footer
+        print_footer(elapsed)
       end
     end
 
@@ -71,8 +73,8 @@ module Discharger
       puts "Configuration loaded from: #{config_path}"
     end
 
-    def print_footer
-      puts "\n== Setup completed successfully! =="
+    def print_footer(elapsed)
+      puts format("\n== Setup completed successfully! (%.2fs) ==", elapsed)
     end
 
     def load_bundler
@@ -89,8 +91,11 @@ module Discharger
       # Load Rails from the standard location
       rails_config = File.join(app_root, "config", "application.rb")
       if File.exist?(rails_config)
-        require rails_config
-        Rails.application.initialize!
+        elapsed = Timing.measure do
+          require rails_config
+          Rails.application.initialize!
+        end
+        puts format("\n== Rails loaded (%.2fs) ==", elapsed)
       else
         puts "Warning: config/application.rb not found. Skipping Rails initialization."
       end

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

@@ -6,9 +6,11 @@ module Discharger
   module SetupRunner
     module Commands
       # Stores bundler credentials for a private GitHub Packages gem source
-      # using the GitHub CLI, so Gemfiles don't need embedded tokens.
-      # Credentials are written to the app's .bundle/config — keep .bundle
-      # gitignored. Run this step before "bundler" in setup.yml.
+      # using the GitHub CLI, so Gemfiles don't need embedded tokens. A token
+      # the source rejects is not stored, so it cannot shadow a working
+      # credential in the user's own bundler config. Credentials are written
+      # to the app's .bundle/config — keep .bundle gitignored. Run this step
+      # before "bundler" in setup.yml.
       class GithubPackagesCommand < BaseCommand
         # A configured source with nothing scheduled to store its credentials
         # is inert, and the only symptom is bundler failing against the
@@ -59,13 +61,14 @@ module Discharger
             return
           end
 
-          store_bundler_credentials(username, token)
-          if credentials_valid?(username, token)
-            log "Configured bundler credentials for #{source}"
-          else
-            log "#{source} rejected the stored credentials. Your gh token may lack " \
-              "the read:packages scope — run `gh auth refresh -s read:packages` and rerun setup."
+          unless credentials_valid?(username, token)
+            log "#{source} rejected the gh token, so bundler credentials were left alone. The token " \
+              "may lack the read:packages scope — run `gh auth refresh -s read:packages` and rerun setup."
+            return
           end
+
+          store_bundler_credentials(username, token)
+          log "Configured bundler credentials for #{source}"
         end
 
         def can_execute?

data/lib/discharger/setup_runner/configuration.rb

@@ -39,7 +39,7 @@ module Discharger
     end
 
     class DatabaseConfig
-      attr_accessor :port, :name, :version, :password, :prefer_docker
+      attr_accessor :port, :name, :version, :password, :prefer_docker, :db_name
 
       def initialize
         @port = 5432
@@ -47,6 +47,7 @@ module Discharger
         @version = "14"
         @password = "postgres"
         @prefer_docker = nil
+        @db_name = nil
       end
 
       def from_hash(hash)
@@ -55,6 +56,7 @@ module Discharger
         @version = hash["version"] if hash["version"]
         @password = hash["password"] if hash["password"]
         @prefer_docker = hash["prefer_docker"] if hash.key?("prefer_docker")
+        @db_name = hash["db_name"] if hash.key?("db_name")
       end
     end
 

data/lib/discharger/setup_runner/prerequisites_loader.rb

@@ -86,15 +86,17 @@ module Discharger
       end
 
       def set_db_name(db_config)
-        if db_config["name"] && !ENV["DB_NAME"]
-          container_name = db_config["name"].to_s
-          db_name = container_name.sub(/^db-/, "")
+        return if db_config["db_name"] == false
+
+        container_name = db_config["name"].to_s
+        db_name = (db_config["db_name"] || container_name.sub(/^db-/, "")).to_s
+        return if db_name.empty?
+
+        if ENV["DB_NAME"]
+          warn_if_mismatch("DB_NAME", ENV["DB_NAME"], db_name)
+        else
           ENV["DB_NAME"] = db_name
           puts "  Setting DB_NAME=#{db_name} from config/setup.yml (container: #{container_name})"
-        elsif ENV["DB_NAME"]
-          container_name = db_config["name"].to_s
-          expected_db_name = container_name.sub(/^db-/, "")
-          warn_if_mismatch("DB_NAME", ENV["DB_NAME"], expected_db_name)
         end
       end
 

data/lib/discharger/setup_runner/runner.rb

@@ -2,6 +2,7 @@
 
 require "fileutils"
 require "logger"
+require_relative "../timing"
 require_relative "command_factory"
 
 module Discharger
@@ -27,12 +28,14 @@ module Discharger
 
         warn_unscheduled_commands
 
-        FileUtils.chdir app_root do
-          execute_commands
+        elapsed = Timing.measure do
+          FileUtils.chdir app_root do
+            execute_commands
+          end
         end
 
         unless ENV["QUIET_SETUP"] || ENV["DISABLE_OUTPUT"]
-          puts Rainbow("\n✅ Setup completed successfully!").bright.green
+          puts Rainbow(format("\n✅ Setup completed successfully! (%.2fs)", elapsed)).bright.green
         end
       rescue => e
         unless ENV["QUIET_SETUP"] || ENV["DISABLE_OUTPUT"]
@@ -108,7 +111,10 @@ module Discharger
         unless ENV["QUIET_SETUP"] || ENV["DISABLE_OUTPUT"]
           puts Rainbow("\n▶️  #{command.description}").bright
         end
-        command.execute
+        elapsed = Timing.measure { command.execute }
+        unless ENV["QUIET_SETUP"] || ENV["DISABLE_OUTPUT"]
+          puts Rainbow(format("   %s: %.2fs", command.description, elapsed)).faint
+        end
       rescue => e
         unless ENV["QUIET_SETUP"] || ENV["DISABLE_OUTPUT"]
           require "rainbow"

data/lib/discharger/task.rb

@@ -266,6 +266,10 @@ module Discharger
       message
     end
 
+    def echo_unsent_slack_message(text, channel)
+      sysecho "Post this to #{channel} yourself:\n\n#{text}\n"
+    end
+
     def existing_pr_number(base, head)
       stdout, _, status = Open3.capture3(
         "gh", "pr", "list",
@@ -459,17 +463,33 @@ module Discharger
 
         desc "Send a message to Slack."
         task :slack, [:text, :channel, :emoji, :ts] => :environment do |_, args|
+          instance_variable_set(:@last_message_ts, nil)
           args.with_defaults(
             channel: release_message_channel,
             emoji: nil
           )
+          if chat_token.blank?
+            sysecho <<~MSG.bg(:yellow).black
+              Slack message not sent: chat_token is not set.
+              Set it with the Slack release token from your team's password manager before the next release.
+            MSG
+            echo_unsent_slack_message(args[:text], args[:channel])
+            next
+          end
+
           client = Slack::Web::Client.new
           options = args.to_h
           options[:icon_emoji] = options.delete(:emoji) if options[:emoji]
           options[:thread_ts] = options.delete(:ts) if options[:ts]
 
           sysecho "Sending message to Slack:".bg(:green).black + " #{args[:text]}"
-          result = client.chat_postMessage(**options)
+          begin
+            result = client.chat_postMessage(**options)
+          rescue Faraday::Error => e
+            sysecho "Slack message not sent: #{e.message}.".bg(:yellow).black
+            echo_unsent_slack_message(args[:text], args[:channel])
+            next
+          end
           instance_variable_set(:@last_message_ts, result["ts"])
           sysecho %(Message sent: #{result["ts"]})
         end

data/lib/discharger/timing.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Discharger
+  module Timing
+    # Seconds the block took, from the monotonic clock.
+    def self.measure
+      started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      yield
+      Process.clock_gettime(Process::CLOCK_MONOTONIC) - started
+    end
+  end
+end

data/lib/discharger/version.rb

@@ -1,3 +1,3 @@
 module Discharger
-  VERSION = "0.4.0"
+  VERSION = "0.4.2"
 end

data/lib/generators/discharger/install/install_generator.rb

@@ -8,7 +8,14 @@ module Discharger
         default: "bin/setup",
         desc: "Path where the setup script should be created"
 
+      class_option :setup_only,
+        type: :boolean,
+        default: false,
+        desc: "Only (re)generate the setup script, leaving config/setup.yml and the initializer alone"
+
       def copy_initializer
+        return if options[:setup_only]
+
         template "discharger_initializer.rb", "config/initializers/discharger.rb"
       end
 
@@ -18,6 +25,8 @@ module Discharger
       end
 
       def create_sample_setup_yml
+        return if options[:setup_only]
+
         template "setup.yml", "config/setup.yml"
       end
     end

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

@@ -1,30 +1,64 @@
 #!/usr/bin/env ruby
 
-# Path to the application root.
-APP_ROOT = File.expand_path("..", __dir__)
-
-Dir.chdir(APP_ROOT) do
-  # This script uses Discharger to set up your development environment automatically.
-  # All setup steps are configured in config/setup.yml
-  # This script is idempotent, so you can run it at any time and get an expectable outcome.
-
-  # Find discharger gem path from Gemfile without loading bundler
-  # (loading bundler early can cause gem version conflicts)
-  gemfile = File.read("Gemfile")
-  if (match = gemfile.match(/gem\s+["']discharger["'].*path:\s*["']([^"']+)["']/))
-    discharger_path = File.expand_path(match[1], APP_ROOT)
-    $LOAD_PATH.unshift(File.join(discharger_path, "lib"))
-  else
-    # Fall back to installed gem
-    begin
-      gem "discharger"
-    rescue Gem::MissingSpecError
-      puts "Could not find discharger gem."
-      puts "If using a custom bundle path, try: bundle exec bin/setup"
-      exit 1
+# GENERATED BY DISCHARGER. DO NOT EDIT. Edits here are lost on regeneration.
+#
+# App setup belongs in config/setup.yml (pre_steps, steps, custom_steps).
+# Script changes belong in the discharger gem's template,
+# lib/generators/discharger/install/templates/setup; release it, bump it, then
+#   bin/rails generate discharger:install --setup-only --force
+
+script = File.expand_path(__FILE__)
+Dir.chdir(File.expand_path("..", __dir__))
+
+# First pass, standard library only: the bundle may not exist yet. Re-exec
+# under bundle exec before yaml loads, or a default psych clashes with Gemfile.lock.
+# Mirrors the github_packages and bundler steps, which re-run under bundle exec.
+unless ENV["DISCHARGER_SETUP_BUNDLED"]
+  def store_github_packages_credentials
+    require "yaml"
+    source = begin
+      YAML.safe_load_file("config/setup.yml")&.dig("github_packages", "source")
+    rescue SystemCallError, Psych::Exception
+      nil # reported by Discharger::Setup on the second pass
+    end
+    return if source.to_s.empty?
+
+    username = `gh api user --jq .login 2>/dev/null`.strip
+    token = `gh auth token 2>/dev/null`.strip
+    return if username.empty? || token.empty?
+    unless source_confirms_token?(source, username, token)
+      warn "Leaving bundler credentials for #{source} alone: it did not accept the gh token (gh auth refresh -s read:packages)"
+      return
+    end
+
+    system("bundle", "config", "set", "--local", source, "#{username}:#{token}", out: File::NULL, err: File::NULL)
+  end
+
+  def source_confirms_token?(source, username, token)
+    require "net/http"
+    uri = URI.join("#{source.chomp("/")}/", "versions")
+    response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
+      request = Net::HTTP::Get.new(uri)
+      request.basic_auth(username, token)
+      http.request(request)
     end
+    !%w[401 403].include?(response.code)
+  rescue
+    false
+  end
+
+  unless system("bundle", "check", out: File::NULL, err: File::NULL)
+    store_github_packages_credentials
+    system("bundle", "install") || abort(<<~MSG)
+
+      == bundle install failed ==
+      If the Gemfile uses a private GitHub Packages source, run `gh auth login`
+      (or `gh auth refresh -s read:packages`) and rerun bin/setup.
+    MSG
   end
 
-  require "discharger/setup"
-  Discharger::Setup.run("config/setup.yml")
+  exec({"DISCHARGER_SETUP_BUNDLED" => "1"}, "bundle", "exec", RbConfig.ruby, script, *ARGV)
 end
+
+require "discharger/setup"
+Discharger::Setup.run("config/setup.yml")

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: discharger
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Jim Gay
-- Savannah Moore
+- Savannah Albanez
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -135,6 +135,7 @@ files:
 - lib/discharger/setup_runner/runner.rb
 - lib/discharger/setup_runner/version.rb
 - lib/discharger/task.rb
+- lib/discharger/timing.rb
 - lib/discharger/version.rb
 - lib/generators/discharger/install/install_generator.rb
 - lib/generators/discharger/install/templates/discharger_initializer.rb