discharger 0.2.11 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23bf801a204e17e5f37876fba770bc9610814b629ee570924c04414547bc801b
-  data.tar.gz: 594b4fceeb396a77ada63a549eee831d72ea6b1c942ff1a1ac813cea877e6c56
+  metadata.gz: 9ce45e28ffd20d694eec7075403138701e726efbaef6f5b5000e51c34eca3961
+  data.tar.gz: f378cf858c863d47255ea695ed95daf676c7943ea1ac7d5f4f2044cb04604d17
 SHA512:
-  metadata.gz: ec6dadb8198acd18144256694bcfdd0cd7c58275e6ad8f2ed6d9bc374633db99e6bf50278fb137a7675af74759e9ecc885dc8450852e2561655b0d5ba6e2cf75
-  data.tar.gz: fcf463c7d4e9721b4a94a470a6ee0b75673888cf0f0c9e87fa998f208e0a3a1a88d8338de4add5ae1205f1a643e0ae49b59f814bf28854c5cd78bb5a09b96b0e
+  metadata.gz: 466259f1fd4d919e807694c007e59292eeaa8ef2d5f3b50e8ae7fdb2ae5514e2cec983c903c4d6667ec16fc8a7129c0b28146cc21eb9bc721f6129d37c872267
+  data.tar.gz: 8e99e498e7c594b168e8835fad33111ec2b8d4e08d96a2434cae97c9bebcd71ba55a48ab7cf50a59eaae976651b74503001a424d06fcbc82e250fc192924e86a

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+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.13] - 2025-09-02
+
+### Added
+
+- Added clean up fragment_directory task on Task.
+- Added trusted publisher flow to GitHub release action.
+- Adding commit step if needed after the finalize.
+
+### Fixed
+
+- Fixed version on GitHub trusted publisher action.
+- 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

@@ -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/Rakefile

@@ -10,6 +10,7 @@ Reissue::Task.create :reissue do |task|
   task.commit = !ENV["GITHUB_ACTIONS"]
   task.commit_finalize = !ENV["GITHUB_ACTIONS"]
   task.push_finalize = :branch
+  task.clear_fragments = true
 end
 
 Rake::TestTask.new(:test) do |t|

data/lib/discharger/task.rb

@@ -16,6 +16,8 @@ module Discharger
         reissue.updated_paths = task.updated_paths
         reissue.commit = task.commit
         reissue.commit_finalize = task.commit_finalize
+        reissue.fragment_directory = task.fragment_directory
+        reissue.clear_fragments = task.clear_fragments
       end
       task.define
       task
@@ -36,6 +38,8 @@ module Discharger
     attr_accessor :app_name
     attr_accessor :commit_identifier
     attr_accessor :pull_request_url
+    attr_accessor :fragment_directory
+    attr_accessor :clear_fragments
 
     attr_reader :last_message_ts
 
@@ -53,6 +57,7 @@ module Discharger
       @staging_branch = "stage"
       @production_branch = "main"
       @description = "Release the current version to #{staging_branch}"
+      @clear_fragments = true
     end
     private attr_reader :tasker
 

data/lib/discharger/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discharger
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.13
 platform: ruby
 authors:
 - Jim Gay
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile