discharger 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23bf801a204e17e5f37876fba770bc9610814b629ee570924c04414547bc801b
-  data.tar.gz: 594b4fceeb396a77ada63a549eee831d72ea6b1c942ff1a1ac813cea877e6c56
+  metadata.gz: 0556c953dac93a704d652f69824bd24da384f42c204487340512beafde360f95
+  data.tar.gz: f3224ed2f8bc399bc7a9e33014334843058a4e44540fc8a14e34fa47091611d5
 SHA512:
-  metadata.gz: ec6dadb8198acd18144256694bcfdd0cd7c58275e6ad8f2ed6d9bc374633db99e6bf50278fb137a7675af74759e9ecc885dc8450852e2561655b0d5ba6e2cf75
-  data.tar.gz: fcf463c7d4e9721b4a94a470a6ee0b75673888cf0f0c9e87fa998f208e0a3a1a88d8338de4add5ae1205f1a643e0ae49b59f814bf28854c5cd78bb5a09b96b0e
+  metadata.gz: 33ace7f51a07a0c126ba03285cde6695bdb5b38a84b796ca1588a16695dac532f9222340ca683ed5b2b7ae5e61d1abc3704f444db15ee2ba73a60f6e2e95f6a4
+  data.tar.gz: f0c3821be4631d3a804a71f68df53a56b7788f7d56598361d540027b7118f79466ba8e82a082ddac1bd2c124c8e4002f37e5f5cb3aa8da62ffbe7a4da97ee842

data/README.md

@@ -1,26 +1,80 @@
 # Discharger
-Code supporting tasks that discharge code for deployment.
 
-## Usage
+A Ruby gem that provides Rake tasks for managing code deployment workflows with automated versioning, changelog management, and Slack notifications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "discharger"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Then run the install generator:
+```bash
+$ rails generate discharger:install
+```
 
-Add `require "discharger/task"` to your Rakefile.
+Or install it yourself as:
+```bash
+$ gem install discharger
+```
 
-Then build the discharger task
+## Usage
+
+Add `require "discharger/task"` to your Rakefile, then configure the discharger task:
 
 ```ruby
 require "discharger/task"
 
 Discharger::Task.create do |task|
+  # Version management
   task.version_file = "config/application.rb"
-  task.release_message_channel = "#some-slack-channel"
   task.version_constant = "MyApp::VERSION"
-  task.app_name = "My App name"
+  
+  # Slack integration
+  task.release_message_channel = "#some-slack-channel"
+  task.app_name = "My App Name"
+  
+  # Git integration
   task.commit_identifier = -> { `git rev-parse HEAD`.strip }
   task.pull_request_url = "https://github.com/SOFware/some-app"
+  
+  # Changelog management (optional)
+  task.fragment_directory = "changelog.d"  # Directory for changelog fragments
 end
 ```
 
-It will make Rake tasks available to push code to branches and notify Slack channels.
+### 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.
+
+```ruby
+Discharger::Task.create do |task|
+  # ... other configuration ...
+  task.fragment_directory = "changelog.d"  # Default: nil (disabled)
+end
+```
+
+With fragments enabled, you can create individual changelog files in the `changelog.d/` directory:
+
+```
+changelog.d/
+├── 123-fix-login-bug.md
+├── 124-add-user-profile.md
+└── 125-update-dependencies.md
+```
+
+Each fragment file should contain the changelog entry for a specific change or feature.
+
+## Available Tasks
+
+The gem creates several Rake tasks for managing your deployment workflow:
 
 ```bash
 $ rake -T release
@@ -32,27 +86,11 @@ 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:
+### Workflow Steps
 
-```ruby
-gem "discharger"
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Then run the install generator:
-```bash
-$ rails generate discharger:install
-```
-
-Or install it yourself as:
-```bash
-$ gem install discharger
-```
+1. **Prepare** (`rake release:prepare`): Create a new branch to prepare the release, update the changelog, and bump the version
+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
 
 ## Contributing
 
@@ -71,4 +109,5 @@ Releases are automated via GitHub Actions:
 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/lib/discharger/task.rb

@@ -16,6 +16,7 @@ module Discharger
         reissue.updated_paths = task.updated_paths
         reissue.commit = task.commit
         reissue.commit_finalize = task.commit_finalize
+        reissue.fragment_directory = task.fragment_directory
       end
       task.define
       task
@@ -36,6 +37,7 @@ module Discharger
     attr_accessor :app_name
     attr_accessor :commit_identifier
     attr_accessor :pull_request_url
+    attr_accessor :fragment_directory
 
     attr_reader :last_message_ts
 

data/lib/discharger/version.rb

@@ -1,3 +1,3 @@
 module Discharger
-  VERSION = "0.2.11"
+  VERSION = "0.2.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discharger
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Jim Gay
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Tasks for discharging an application for deployment.
 test_files: []