discharger 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 115ce3036bb2da29f6afcde6015de3d019cb8bd228e8a8b655fce03dce0bfab6
-  data.tar.gz: 056c7cdb11e704cbb0a20425fef6edb21d80f8f33cb1f6a36930e2ea48e9bb19
+  metadata.gz: e92d9aa7bcc8894b1db11f44195b1fc5ac26d7995debf672867d4739b8bf3002
+  data.tar.gz: a813680ef1fdecbaf8ae436b47d8f11e2d2d2a306dea0f6de03fbbe085035b9f
 SHA512:
-  metadata.gz: 0e26e1ca08b82035ff400055d8ce554f14c54a5894e3dae192cb3711b02018f54871157d3ca84c0cecfecd737a9038ed64dae5f093fe7d3853bb6c1a3828a6f4
-  data.tar.gz: f31eb92df8f4396bde953c27a5ff5544657124f0b8077a7b941566c433e7bc437bca657bf896e02e95b824591f63e4c94c4392c87cc271f64517f431b19c7bf7
+  metadata.gz: 957623082c1bd56b60223cf6c940bbed32c46612daad4baaf2fd2ad542f297637ecd0aee033ce50c75ba42cefc43299a35e48d603b373b723c688a91340bf01f
+  data.tar.gz: b28f208e2e4057f8d795d01600d840e3634bf75f88968852278bfe624b6a570135a6dda25aa0f95a3b9fb0e489e2950d4c4dcc459639da365e30f84e0073b8bf

data/CHANGELOG.md

@@ -5,30 +5,23 @@ 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.5.1] - 2026-10-02
-
-## [0.5.0] - 2026-10-02
+## [0.5.2] - 2026-10-05
 
 ### Added
 
-- discharger:setup:check fails when bin/setup is missing or differs from the installed gem's template, naming the regenerate command and the first differing line (512544a)
+- github_packages.gh_timeout in setup.yml sets the gh deadline (e7d7620)
+- pre_steps print elapsed time (9bdb05f)
 
 ### Changed
 
-- Setup creates missing config/**/*.example and .env.example counterparts before pre_steps and Rails, so apps no longer copy them in pre_steps (e7a8ce9)
-- rake release refuses to reset the working branch over unpushed local commits (6d87ce7)
-- rake release tags the release commit on the working branch and pushes the tag; nothing merges into a production branch (af4484d)
-- working_branch defaults to main (af4484d)
-- rake release checks the tree, unpushed commits, the release commit and the tag before asking to confirm (af4484d)
-- rake release stops with a clear message when the version's tag already exists on origin (af4484d)
+- github_packages step only checks the gh token; bin/setup stores credentials (e7d7620)
 
 ### Removed
 
-- staging_branch, production_branch, auto_deploy_staging and description settings; their writers warn and do nothing until 0.6 (af4484d)
-- release:stage, release:build and DISCHARGER_BUILD_BRANCH (af4484d)
-- the runbook preview on the stage build (af4484d)
+- the unreachable seed_env option (8b7c654)
 
 ### Fixed
 
-- bin/setup stores a gh token only when the GitHub Packages source answers 2xx (0ed1239)
-- The yarn step installs the packageManager yarn with corepack install instead of corepack use, so setup no longer rewrites package.json (91967a1)
+- gh calls in setup time out after 15s instead of hanging (e7d7620)
+
+## [0.5.1] - 2026-10-02

data/README.md

@@ -195,7 +195,8 @@ You can rerun it whenever your environment drifts. Every run drops and rebuilds
 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
+accepts that token; gh calls time out after `github_packages.gh_timeout` seconds,
+15 by default, or `DISCHARGER_GH_TIMEOUT`), 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
@@ -204,8 +205,8 @@ creates every missing counterpart of `config/**/*.example` and `.env.example`, s
 app whose boot needs `.env` or `config/database.yml` gets them without copying
 them in `pre_steps`.
 
-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.
+Each pre_step and 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
 
@@ -307,8 +308,8 @@ The `steps` array specifies which built-in setup commands to run. Available comm
 - `brew` - Install Homebrew dependencies
 - `asdf` - Setup version management with asdf
 - `git` - Configure git settings
-- `github_packages` - Store bundler credentials for a private GitHub Packages gem source using the GitHub CLI (run before `bundler`; requires a `github_packages.source` config entry)
-- `bundler` - Install Ruby gems
+- `github_packages` - Check the GitHub CLI token against a private GitHub Packages gem source; the generated `bin/setup` stores the credentials (requires a `github_packages.source` config entry)
+- `bundler` - Install Ruby gems; a check under the generated `bin/setup`, whose first pass already installed the bundle
 - `yarn` - Install JavaScript packages
 - `config` - Copy Procfile.dev to Procfile and any example config file still missing
 - `docker` - Setup Docker containers

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

@@ -5,6 +5,7 @@ require_relative "base_command"
 module Discharger
   module SetupRunner
     module Commands
+      # bin/setup's first pass mirrors this; change them together.
       class BundlerCommand < BaseCommand
         def execute
           log "Installing dependencies"

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

@@ -31,9 +31,8 @@ module Discharger
           end
 
           # Seed the database
-          seed_env = db_env.merge((config.respond_to?(:seed_env) && config.seed_env) ? {"SEED_DEV_ENV" => "true"} : {})
           with_spinner("Seeding the database") do
-            _stdout, stderr, status = Open3.capture3(seed_env, "bin/rails", "db:seed")
+            _stdout, stderr, status = Open3.capture3(db_env, "bin/rails", "db:seed")
             if status.success?
               {success: true}
             else

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

@@ -5,43 +5,10 @@ require_relative "base_command"
 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. 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.
+      # Checks the gh token against the GitHub Packages source; bin/setup
+      # stored the credentials. The template's first pass mirrors this.
       class GithubPackagesCommand < BaseCommand
-        # A configured source with nothing scheduled to store its credentials
-        # is inert, and the only symptom is bundler failing against the
-        # private source. The Runner surfaces this before executing commands.
-        # Guarded for duck-typed configs passed to the public Runner API, and
-        # quiet when a custom step's command references the source (assumed
-        # to handle credentials itself).
-        def self.unscheduled_warning(config)
-          return unless config.respond_to?(:github_packages)
-
-          source = config.github_packages&.source
-          return if source.to_s.empty?
-          if config.respond_to?(:custom_steps) &&
-              config.custom_steps.any? { |step| step_handles_source?(step, source) }
-            return
-          end
-
-          "github_packages is configured but missing from steps; " \
-            "credentials will not be stored and bundler may fail for #{source}"
-        end
-
-        # A referencing step only counts as handling credentials when it will
-        # actually run: CustomCommand skips itself when its condition is
-        # false, storing nothing on this run.
-        def self.step_handles_source?(step, source)
-          return false unless step["command"].to_s.include?(source)
-
-          require_relative "../condition_evaluator"
-          ConditionEvaluator.evaluate(step["condition"])
-        end
-        private_class_method :step_handles_source?
+        GH_TIMEOUT_SECONDS = 15
 
         def execute
           unless gh_installed?
@@ -61,14 +28,12 @@ module Discharger
             return
           end
 
-          unless source_accepts_token?(username, token)
-            log "Leaving bundler credentials for #{source} alone: it did not accept the gh token. The token " \
-              "may lack the read:packages scope — run `gh auth refresh -s read:packages` and rerun setup."
-            return
+          if source_accepts_token?(username, token)
+            log "#{source} accepts the gh token"
+          else
+            log "#{source} did not accept the gh token. It may lack the read:packages scope — " \
+              "run `gh auth refresh -s read:packages` and rerun setup."
           end
-
-          store_bundler_credentials(username, token)
-          log "Configured bundler credentials for #{source}"
         end
 
         def can_execute?
@@ -76,7 +41,7 @@ module Discharger
         end
 
         def description
-          "Configure GitHub Packages credentials"
+          "Check GitHub Packages credentials"
         end
 
         protected
@@ -90,7 +55,7 @@ module Discharger
         end
 
         def authenticated?
-          system_quiet("gh auth status")
+          !gh("auth", "status").nil?
         end
 
         def login
@@ -102,18 +67,24 @@ module Discharger
 
         def gh(*args)
           require "open3"
-          stdout, _stderr, status = Open3.capture3("gh", *args)
-          status.success? ? stdout.chomp : nil
+          Open3.popen2("gh", *args, err: File::NULL) do |stdin, stdout, wait|
+            stdin.close
+            out = Thread.new { stdout.read }
+            if wait.join(gh_timeout)
+              out.value.chomp if wait.value.success?
+            else
+              Process.kill("KILL", wait.pid)
+              out.kill
+              log "gh #{args.join(" ")} did not answer within #{gh_timeout.to_i}s."
+              nil
+            end
+          end
+        rescue Errno::ENOENT
+          nil
         end
 
-        # Runs bundle config directly instead of through system! so the
-        # token never reaches the spinner display or the debug log.
-        def store_bundler_credentials(username, token)
-          require "open3"
-          _stdout, stderr, status = Open3.capture3(
-            "bundle", "config", "set", "--local", source, "#{username}:#{token}"
-          )
-          raise "bundle config set --local #{source} failed: #{stderr}" unless status.success?
+        def gh_timeout
+          Float(ENV.fetch("DISCHARGER_GH_TIMEOUT") { config.github_packages&.gh_timeout || GH_TIMEOUT_SECONDS })
         end
 
         def source_accepts_token?(username, token)

data/lib/discharger/setup_runner/configuration.rb

@@ -61,14 +61,16 @@ module Discharger
     end
 
     class GithubPackagesConfig
-      attr_accessor :source
+      attr_accessor :source, :gh_timeout
 
       def initialize
         @source = nil
+        @gh_timeout = nil
       end
 
       def from_hash(hash)
         @source = hash["source"] if hash["source"]
+        @gh_timeout = hash["gh_timeout"] if hash["gh_timeout"]
       end
     end
 

data/lib/discharger/setup_runner/prerequisites_loader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "yaml"
+require_relative "../timing"
 require_relative "pre_commands/pre_command_registry"
 
 module Discharger
@@ -130,8 +131,7 @@ module Discharger
         end
 
         command = command_class.new(config)
-        puts "  #{command.description}..."
-        command.execute
+        timed(command.description) { command.execute }
       end
 
       def run_custom_pre_step(step)
@@ -144,8 +144,12 @@ module Discharger
           return
         end
 
-        puts "  Running: #{description}"
-        system(command)
+        timed(description) { system(command) }
+      end
+
+      def timed(description)
+        elapsed = Timing.measure { yield }
+        puts format("  %s: %.2fs", description, elapsed)
       end
 
       def evaluate_condition(condition)

data/lib/discharger/setup_runner/runner.rb

@@ -26,8 +26,6 @@ module Discharger
           puts Rainbow("=" * 50).blue
         end
 
-        warn_unscheduled_commands
-
         elapsed = Timing.measure do
           FileUtils.chdir app_root do
             execute_commands
@@ -81,18 +79,6 @@ module Discharger
         @commands ||= command_factory.create_all_commands
       end
 
-      # Checked at run time, after the customization block, so commands
-      # scheduled through add_command/insert_command_* count as scheduled.
-      def warn_unscheduled_commands
-        CommandRegistry.all.each do |klass|
-          next unless klass.respond_to?(:unscheduled_warning)
-          next if commands.any? { |command| command.is_a?(klass) }
-
-          message = klass.unscheduled_warning(config)
-          logger.warn message if message
-        end
-      end
-
       def execute_commands
         commands.each do |command|
           execute_command(command)

data/lib/discharger/version.rb

@@ -1,3 +1,3 @@
 module Discharger
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

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

@@ -14,18 +14,21 @@ Dir.chdir(File.expand_path("..", __dir__))
 # 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"]
+  # Mirrors GithubPackagesCommand and BundlerCommand in the gem; change them together.
   def store_github_packages_credentials
     require "yaml"
-    source = begin
-      YAML.safe_load_file("config/setup.yml")&.dig("github_packages", "source")
+    packages = begin
+      YAML.safe_load_file("config/setup.yml")&.dig("github_packages") || {}
     rescue SystemCallError, Psych::Exception
-      nil # reported by Discharger::Setup on the second pass
+      {} # reported by Discharger::Setup on the second pass
     end
+    source = packages["source"]
     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?
+    timeout = Float(ENV.fetch("DISCHARGER_GH_TIMEOUT") { packages["gh_timeout"] || 15 })
+    username = gh("api", "user", "--jq", ".login", timeout: timeout)
+    token = gh("auth", "token", timeout: timeout)
+    return if username.to_s.empty? || token.to_s.empty?
     unless source_accepts_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
@@ -34,6 +37,24 @@ unless ENV["DISCHARGER_SETUP_BUNDLED"]
     system("bundle", "config", "set", "--local", source, "#{username}:#{token}", out: File::NULL, err: File::NULL)
   end
 
+  def gh(*args, timeout:)
+    require "open3"
+    Open3.popen2("gh", *args, err: File::NULL) do |stdin, stdout, wait|
+      stdin.close
+      out = Thread.new { stdout.read }
+      if wait.join(timeout)
+        out.value.strip if wait.value.success?
+      else
+        Process.kill("KILL", wait.pid)
+        out.kill
+        warn "gh #{args.join(" ")} did not answer within #{timeout.to_i}s; continuing without credentials"
+        nil
+      end
+    end
+  rescue Errno::ENOENT
+    nil
+  end
+
   def source_accepts_token?(source, username, token)
     require "net/http"
     uri = URI.join("#{source.chomp("/")}/", "versions")

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

@@ -19,12 +19,13 @@ redis:
   version: "latest"
 
 # Private GitHub Packages gem source (optional)
-# Stores bundler credentials from the GitHub CLI (gh) so the Gemfile
-# doesn't need an embedded token. Add "github_packages" to steps, before
-# "bundler". Credentials are written to .bundle/config — keep .bundle
-# gitignored.
+# bin/setup stores bundler credentials from the GitHub CLI (gh) before
+# installing the bundle, so the Gemfile needs no embedded token. Add
+# "github_packages" to steps to check the token on every run. Credentials
+# are written to .bundle/config — keep .bundle gitignored.
 # github_packages:
 #   source: "https://rubygems.pkg.github.com/your-org"
+#   gh_timeout: 15  # seconds to wait for gh; DISCHARGER_GH_TIMEOUT overrides
 
 # Pre-Rails steps (run BEFORE Rails loads)
 # These are for system dependencies and environment setup that must happen
@@ -49,9 +50,9 @@ steps:
   - brew
   - asdf
   - git
-  # Uncomment with the github_packages block above. Must precede bundler.
+  # Uncomment with the github_packages block above to check the token.
   # - github_packages
-  - bundler
+  - bundler  # a check; bin/setup already installed the bundle
   - yarn
   - config
   - docker

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discharger
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Jim Gay