discharger 0.2.13 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ce45e28ffd20d694eec7075403138701e726efbaef6f5b5000e51c34eca3961
-  data.tar.gz: f378cf858c863d47255ea695ed95daf676c7943ea1ac7d5f4f2044cb04604d17
+  metadata.gz: 1318e95cac939c76337bcccee4a9abc6403c854abab6fd9caac9854690f8eb66
+  data.tar.gz: e55e2a6b87075e1a4a02d7ad9ffac6d5d84a4f11d3d7d7cebc14176f4ebd083f
 SHA512:
-  metadata.gz: 466259f1fd4d919e807694c007e59292eeaa8ef2d5f3b50e8ae7fdb2ae5514e2cec983c903c4d6667ec16fc8a7129c0b28146cc21eb9bc721f6129d37c872267
-  data.tar.gz: 8e99e498e7c594b168e8835fad33111ec2b8d4e08d96a2434cae97c9bebcd71ba55a48ab7cf50a59eaae976651b74503001a424d06fcbc82e250fc192924e86a
+  metadata.gz: 9831c798d0e372384d783eafd50287913d99744d610bd93df67235a2ad7a916f0a2a5d31e8e6f44de961671092ee86630c970860ddbdc61d5fc77247ee170dc2
+  data.tar.gz: 5774f102c2bbd0c1eadd4cc6511fc80e719a73f98f90a0447ab4696829eb576a0d3d9ab28fb764e44d6b2fb9448f96ffe0142237a0dd79f64a278a30b93de4d1

data/CHANGELOG.md

@@ -5,6 +5,22 @@ 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.2.14] - 2025-09-23
+
+### Added
+
+- Documentation about setup features and custom commands.
+- Reissue deprecated fragment_directory and added fragment.
+
+### Removed
+
+- Got rid of the prepare release yml and action, only the Release gem to RubyGems.org is needed now.
+- Got rid of the code climate action.
+
+### Fixed
+
+- Updated release documentation.
+
 ## [0.2.13] - 2025-09-02
 
 ### Added
@@ -19,9 +35,3 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added debugging for OIDC.
 - Switching back to version 1.0.0 for trusted publisher
 - Now going for the official RubyGems GitHub action for the gem publishing.
-
-## [0.2.12] - 2025-08-19
-
-### Added
-
-- Added fragment directory attribute for task configuration.

data/README.md

@@ -46,18 +46,18 @@ Discharger::Task.create do |task|
   task.pull_request_url = "https://github.com/SOFware/some-app"
   
   # Changelog management (optional)
-  task.fragment_directory = "changelog.d"  # Directory for changelog fragments
+  task.fragment = "changelog.d"  # Directory for changelog fragments
 end
 ```
 
 ### Changelog Fragments
 
-Discharger supports changelog fragment management through the `fragment_directory` setting. When set, Discharger will look for changelog fragments in the specified directory and automatically combine them into the main changelog during releases.
+Discharger supports changelog fragment management through the `fragment` setting from [Reissue](https://github.com/SOFware/reissue?tab=readme-ov-file#configuration-options).
 
 ```ruby
 Discharger::Task.create do |task|
   # ... other configuration ...
-  task.fragment_directory = "changelog.d"  # Default: nil (disabled)
+  task.fragment = "changelog.d"  # Default: nil (disabled), or use :git
 end
 ```
 
@@ -92,19 +92,194 @@ rake release:stage                      # ---------- STEP 2 ----------
 2. **Stage** (`rake release:stage`): Update the staging branch and create a PR to production
 3. **Release** (`rake release`): Release the current version to production by tagging and pushing to the production branch
 
+### Building with a Working Branch
+
+To release a specific working branch to stage instead of the default branch, use the `DISCHARGER_BUILD_BRANCH` environment variable:
+
+```bash
+DISCHARGER_BUILD_BRANCH=your-feature-branch rake build
+```
+
+This will deploy your working branch to the staging environment.
+
+#### Configuring Branch Names
+
+You can configure the branch names in your Rakefile when setting up the discharger task:
+
+```ruby
+require "discharger"
+
+Discharger::Task.new do |task|
+  task.app_name = "MyApp"
+  task.working_branch = ENV.fetch("WORKING_BRANCH", "develop")
+  task.staging_branch = ENV.fetch("STAGING_BRANCH", "stage")
+  task.production_branch = ENV.fetch("PRODUCTION_BRANCH", "main")
+  # ... other configuration
+end
+```
+
+This allows you to use environment variables to override the default branch names, or set project-specific defaults. The `DISCHARGER_BUILD_BRANCH` environment variable (shown above) provides a runtime override specifically for the build task.
+
+## Development Setup Automation
+
+Discharger includes a setup script that automates your development environment configuration. When you run the install generator, it creates a `bin/setup` script and a `config/setup.yml` configuration file.
+
+### Running Setup
+
+After installing Discharger, run the setup script to configure your development environment:
+
+```bash
+$ bin/setup
+```
+
+This script is idempotent - you can run it multiple times safely, and it will ensure your environment is properly configured.
+
+### Configuration
+
+The setup process is configured through `config/setup.yml`. Here's an example configuration:
+
+```yaml
+app_name: "YourAppName"
+
+database:
+  port: 5432
+  name: "db-your-app"
+  version: "14"
+  password: "postgres"
+
+redis:
+  port: 6379
+  name: "redis-your-app"
+  version: "latest"
+
+# Built-in commands to run
+steps:
+  - brew
+  - asdf
+  - git
+  - bundler
+  - yarn
+  - config
+  - docker
+  - env
+  - database
+
+# Custom commands for your application
+custom_steps:
+  - description: "Seed application data"
+    command: "bin/rails db:seed"
+```
+
+### Using Default Steps
+
+The `steps` array specifies which built-in setup commands to run. Available commands include:
+
+- `brew` - Install Homebrew dependencies
+- `asdf` - Setup version management with asdf
+- `git` - Configure git settings
+- `bundler` - Install Ruby gems
+- `yarn` - Install JavaScript packages
+- `config` - Copy configuration files
+- `docker` - Setup Docker containers
+- `env` - Configure environment variables
+- `database` - Setup and migrate database
+
+### Selecting Specific Steps
+
+You can customize which steps run by modifying the `steps` array:
+
+```yaml
+# Only run specific setup steps
+steps:
+  - bundler
+  - database
+  - yarn
+```
+
+Leave the array empty or omit it entirely to run all available steps.
+
+### Adding Custom Commands
+
+Add application-specific setup tasks using the `custom_steps` section:
+
+```yaml
+custom_steps:
+  # Simple command
+  - description: "Compile assets"
+    command: "bin/rails assets:precompile"
+
+  # Command with condition
+  - description: "Setup Elasticsearch"
+    command: "bin/rails search:setup"
+    condition: "defined?(Elasticsearch)"
+
+  # Command with environment variable condition
+  - description: "Import production data"
+    command: "bin/rails db:import"
+    condition: "ENV['IMPORT_DATA'] == 'true'"
+```
+
+Each custom step can include:
+- `description` - A description shown during setup
+- `command` - The command to execute
+- `condition` - An optional Ruby expression that must evaluate to true for the command to run
+
+### Creating Custom Command Classes
+
+For more complex setup logic, you can create custom command classes that integrate with Discharger's setup system:
+
+```ruby
+# lib/setup_commands/elasticsearch_command.rb
+class ElasticsearchCommand < Discharger::SetupRunner::Commands::BaseCommand
+  def description
+    "Configure Elasticsearch"
+  end
+
+  def can_execute?
+    defined?(Elasticsearch)
+  end
+
+  def execute
+    with_spinner("Setting up Elasticsearch...") do
+      # Your setup logic here
+      system("bin/rails search:setup")
+      system("bin/rails search:reindex")
+    end
+    log "Elasticsearch configured successfully", emoji: "✅"
+  end
+end
+
+# Register the command in an initializer or your setup script
+Discharger::SetupRunner.register_command(:elasticsearch, ElasticsearchCommand)
+```
+
+Then use it in your configuration:
+
+```yaml
+steps:
+  - bundler
+  - database
+  - elasticsearch  # Your custom command
+```
+
+
 ## Contributing
 
 This gem is managed with [Reissue](https://github.com/SOFware/reissue).
 
 ### Releasing
 
-Releases are automated via GitHub Actions:
+Releases are streamlined with a single GitHub Actions workflow using RubyGems Trusted Publishing:
 
-1. Go to Actions → "Prepare Release" → Run workflow
-2. Select version type (major, minor, patch, or custom)
-3. Review the created PR with version bumps and changelog updates
-4. Add the `approved-release` label and merge
-5. The gem will be automatically published to RubyGems.org
+1. Go to Actions → "Release gem to RubyGems.org" → Run workflow
+2. Select version bump type (patch, minor, or major)
+3. The workflow will automatically:
+   - Finalize the changelog with the release date
+   - Build the gem with checksum verification
+   - Publish to RubyGems.org via Trusted Publishing (no API keys needed)
+   - Create a git tag for the release
+   - Bump to the next development version
+   - Open a PR with the version bump for continued development
 
 Bug reports and pull requests are welcome on GitHub.
 

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

@@ -93,7 +93,7 @@ module Discharger
             end
           RUBY
 
-          with_spinner("Terminating existing database connections#{rails_env ? " (#{rails_env})" : ""}") do
+          with_spinner("Terminating existing database connections#{" (#{rails_env})" if rails_env}") do
             stdout, stderr, status = Open3.capture3(env_vars, "bin/rails", "runner", runner_script)
 
             if status.success?

data/lib/discharger/task.rb

@@ -16,7 +16,11 @@ module Discharger
         reissue.updated_paths = task.updated_paths
         reissue.commit = task.commit
         reissue.commit_finalize = task.commit_finalize
-        reissue.fragment_directory = task.fragment_directory
+        if task.fragment_directory
+          warn "fragment_directory is deprecated, use fragment instead"
+          task.fragment = task.fragment_directory
+        end
+        reissue.fragment = task.fragment
         reissue.clear_fragments = task.clear_fragments
       end
       task.define
@@ -39,6 +43,7 @@ module Discharger
     attr_accessor :commit_identifier
     attr_accessor :pull_request_url
     attr_accessor :fragment_directory
+    attr_accessor :fragment
     attr_accessor :clear_fragments
 
     attr_reader :last_message_ts
@@ -46,7 +51,7 @@ module Discharger
     # Reissue settings
     attr_accessor(
       *Reissue::Task.instance_methods(false).reject { |method|
-        method.to_s.match?(/[\?=]\z/) || method_defined?(method)
+        method.to_s.match?(/[?=]\z/) || method_defined?(method)
       }
     )
 
@@ -204,17 +209,20 @@ module Discharger
 
         desc description
         task build: :environment do
+          # Allow overriding the working branch via environment variable
+          build_branch = ENV["DISCHARGER_BUILD_BRANCH"] || working_branch
+
           syscall(
-            ["git fetch origin #{working_branch}"],
-            ["git checkout #{working_branch}"],
-            ["git reset --hard origin/#{working_branch}"],
+            ["git fetch origin #{build_branch}"],
+            ["git checkout #{build_branch}"],
+            ["git reset --hard origin/#{build_branch}"],
             ["git branch -D #{staging_branch} 2>/dev/null || true"],
             ["git checkout -b #{staging_branch}"],
             ["git push origin #{staging_branch} --force"]
           ) do
             current_version = Object.const_get(version_constant)
             tasker["#{name}:slack"].invoke("Building #{app_name} #{current_version} (#{commit_identifier.call}) on #{staging_branch}.", release_message_channel)
-            syscall ["git checkout #{working_branch}"]
+            syscall ["git checkout #{build_branch}"]
           end
         end
 

data/lib/discharger/version.rb

@@ -1,3 +1,3 @@
 module Discharger
-  VERSION = "0.2.13"
+  VERSION = "0.2.14"
 end

metadata

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