ruby-gem-release 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b08ae237496cfc6c20681b49de00754fa64855ca860d47f294cfc32db6a41bc6
-  data.tar.gz: de74d06f4cd776ae788843d29e6b9af1d5bb44cfd3db5a754cae007f895d8dd1
+  metadata.gz: 46ed1a62b715dde573b31f304d33aae0df5eb2a574e42bfb69935a0600c6e43b
+  data.tar.gz: 55f8f60509b26d6f7dac36d02e7d8300c1ab6d87701b6b2b28070cca0fb9a4fe
 SHA512:
-  metadata.gz: 3adf38a074fb0ecc9f260ee4ed1b5554b73e3b197b222e582fed079d4587fe82967e2bbad44979654d9bafa004a394990c378157cd6760c46c2602c250d7100a
-  data.tar.gz: 78cefbdc700cc788584fdbcbb9965e27afacd165d0b91452e133e858a7212eb2f3ca2a8f192c0f92d95d02edf454482dd3f43e29bd6e08d867611ba0c6ef48b5
+  metadata.gz: dcb52020ceab4b9902377d975765adcd67c2ec3de35fb2c4e1d8c6b6af7c37c0d0ec32e188793686b38af00405e110f1d7318988952583ff58675858957eb220
+  data.tar.gz: cd7c6b2e4d8a503c4fb5ef333a9b8ed59ff97788b9a94669ef113ce0333af789d11edb59a84ab84a1b3927bea091b37421150c0959d124c33b5da019e4193c42

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.2.0 (2026/11/07)
+
+- [#15](https://github.com/dblock/ruby-gem-release/pull/15): Add a Marketplace-ready composite action sharing Ruby release tasks, document action setup and publication, and pin workflow examples to `v0.2.0` - [@dblock](https://github.com/dblock).
+- [#16](https://github.com/dblock/ruby-gem-release/pull/16): Preserve release heading depths from `#` through `######` in both changelog formats, without reformatting consumer files - [@dblock](https://github.com/dblock).
+
 ## 0.1.0 (2026/11/07)
 
 - [#2](https://github.com/dblock/ruby-gem-release/pull/2): Add reusable gem release workflow and version management Rake tasks - [@dblock](https://github.com/dblock).

data/README.md

@@ -18,7 +18,7 @@ Requires Ruby 3.3+, GitHub Actions, and RubyGems Trusted Publishing.
 
 ### 1. Configure Your Gem
 
-Add `ruby-gem-release` to the development dependencies and install the standard workflow in your Rakefile. Choose your version file and changelog format explicitly:
+Add `ruby-gem-release` (`~> 0.2.0`) to the development dependencies and install the standard workflow in your Rakefile. Choose your version file and changelog format explicitly:
 
 ```ruby
 require 'ruby-gem-release/workflow/ruby_gem'
@@ -53,7 +53,7 @@ permissions:
 
 jobs:
   release:
-    uses: dblock/ruby-gem-release/.github/workflows/release.yml@master
+    uses: dblock/ruby-gem-release/.github/workflows/release.yml@v0.2.0
     with:
       ruby-version: '3.3'
       rubygems-owner: ${{ inputs.rubygems-owner }}
@@ -91,6 +91,8 @@ gh workflow run release.yml
 
 See [Detailed Usage](docs/usage.md#configuration) for workflow customization, callbacks, and available classes, and the [Actions Reference](docs/actions/release.md) for inputs and defaults.
 
+For step-based integration, see the [Composite Action](docs/actions/action.md).
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md), [DESIGN.md](DESIGN.md), [CHANGELOG.md](CHANGELOG.md), and [RELEASING.md](RELEASING.md).

data/lib/ruby-gem-release/changelog/base.rb

@@ -27,12 +27,12 @@ module RubyGemRelease
         matches.first
       end
 
-      def heading_positions(content, pattern)
+      def heading_positions(content, pattern, max_level: 6)
         lines = content.lines
         offsets = line_offsets(lines)
         matches = []
         document(content).each do |node|
-          next unless node.type == :heading && node.header_level == 2
+          next unless node.type == :heading && node.header_level <= max_level
 
           index = node.source_position[:start_line] - 1
           matches << offsets[index] if pattern.match?(lines[index].chomp)
@@ -40,6 +40,10 @@ module RubyGemRelease
         matches
       end
 
+      def heading_prefix(content, position)
+        content[position, 6][/\A#+/]
+      end
+
       def editable_lines(content)
         excluded = excluded_lines(content)
         offset = 0

data/lib/ruby-gem-release/changelog/intridea.rb

@@ -3,7 +3,7 @@
 module RubyGemRelease
   module Changelog
     class Intridea < Base
-      UNRELEASED = /\A## \d+\.\d+\.\d+ \(Next\)\z/
+      UNRELEASED = /\A\#{1,6} \d+\.\d+\.\d+ \(Next\)\z/
       PLACEHOLDER = '- Your contribution here.'
 
       def initialize(path: 'CHANGELOG.md', placeholder: PLACEHOLDER)
@@ -20,11 +20,11 @@ module RubyGemRelease
         content = File.read(@path)
         separator = newline(content)
         position = heading(content, UNRELEASED)
+        prefix = heading_prefix(content, position)
         check_release_absent(content, version)
-        line_end = line_end(content, position, separator)
-        section_end = heading_positions(content, /\A## /).find { |offset| offset > position } || content.length
-        content[position...section_end] = "## #{version} (#{date.strftime('%Y/%m/%d')})" +
-                                          remove_placeholder(content[line_end...section_end])
+        section_end = section_end_position(content, position, prefix.length)
+        content[position...section_end] = "#{prefix} #{version} (#{date.strftime('%Y/%m/%d')})" +
+                                          remove_placeholder(content[line_end(content, position, separator)...section_end])
         File.write(@path, content)
       end
 
@@ -33,21 +33,26 @@ module RubyGemRelease
         validate_version(released_version)
         content = File.read(@path)
         separator = newline(content)
-        pattern = %r{\A## #{Regexp.escape(released_version)} \(\d{4}/\d{2}/\d{2}\)\z}
+        pattern = %r{\A\#{1,6} #{Regexp.escape(released_version)} \(\d{4}/\d{2}/\d{2}\)\z}
         position = heading(content, pattern)
+        prefix = heading_prefix(content, position)
         check_absent(content, UNRELEASED, 'unreleased heading already exists')
 
-        File.write(@path, content.insert(position, ["## #{version} (Next)", '', @placeholder, '', ''].join(separator)))
+        File.write(@path, content.insert(position, ["#{prefix} #{version} (Next)", '', @placeholder, '', ''].join(separator)))
       end
 
       def check_release_absent(content, version)
-        check_absent(content, %r{\A## #{Regexp.escape(version)} \(\d{4}/\d{2}/\d{2}\)\z}, 'release heading already exists')
+        check_absent(content, %r{\A\#{1,6} #{Regexp.escape(version)} \(\d{4}/\d{2}/\d{2}\)\z}, 'release heading already exists')
       end
 
       def line_end(content, position, separator)
         content.index(separator, position) || raise(ArgumentError, "heading must end with a newline in #{@path}")
       end
 
+      def section_end_position(content, position, level)
+        heading_positions(content, /\A\#{1,6} /, max_level: level).find { |offset| offset > position } || content.length
+      end
+
       def remove_placeholder(section)
         positions = []
         editable_lines(section) { |line, offset| positions << offset if line.chomp == @placeholder }

data/lib/ruby-gem-release/changelog/keep_a_changelog.rb

@@ -3,7 +3,7 @@
 module RubyGemRelease
   module Changelog
     class KeepAChangelog < Base
-      UNRELEASED = /\A## \[Unreleased\]\z/
+      UNRELEASED = /\A\#{1,6} \[Unreleased\]\z/
 
       private
 
@@ -12,11 +12,11 @@ module RubyGemRelease
         content = File.read(@path)
         separator = newline(content)
         position = heading(content, UNRELEASED)
-        check_absent(content, /\A## \[#{Regexp.escape(version)}\] - \d{4}-\d{2}-\d{2}\z/, 'release heading already exists')
+        check_absent(content, /\A\#{1,6} \[#{Regexp.escape(version)}\] - \d{4}-\d{2}-\d{2}\z/, 'release heading already exists')
         line_end = content.index(separator, position)
         raise ArgumentError, "heading must end with a newline in #{@path}" unless line_end
 
-        content[position...line_end] = "## [#{version}] - #{date.strftime('%Y-%m-%d')}"
+        content[position...line_end] = "#{heading_prefix(content, position)} [#{version}] - #{date.strftime('%Y-%m-%d')}"
         release_references(content, version, separator)
         File.write(@path, content)
       end
@@ -26,12 +26,13 @@ module RubyGemRelease
         validate_version(released_version)
         content = File.read(@path)
         separator = newline(content)
-        pattern = /\A## \[#{Regexp.escape(released_version)}\] - \d{4}-\d{2}-\d{2}\z/
+        pattern = /\A\#{1,6} \[#{Regexp.escape(released_version)}\] - \d{4}-\d{2}-\d{2}\z/
         position = heading(content, pattern)
+        prefix = heading_prefix(content, position)
         check_absent(content, UNRELEASED, 'unreleased heading already exists')
         check_next_reference(content, released_version)
 
-        File.write(@path, content.insert(position, ['## [Unreleased]', '', ''].join(separator)))
+        File.write(@path, content.insert(position, ["#{prefix} [Unreleased]", '', ''].join(separator)))
       end
 
       def references(content, label)

data/lib/ruby-gem-release/tasks.rb

@@ -49,6 +49,7 @@ module RubyGemRelease
 
     def install_workflow_tasks
       namespace :workflow do
+        task(:configure) { Workflow::Context.new.configure! }
         task(:capture) { Workflow::Context.new.capture! }
         task(:resolve) { Workflow::Context.new.resolve! }
         task(:credentials) { Workflow::RubyGemsCredentials.new(owner: ENV.fetch('RUBYGEMS_OWNER')).configure! }

data/lib/ruby-gem-release/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyGemRelease
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/ruby-gem-release/workflow/context.rb

@@ -8,6 +8,13 @@ require_relative '../version/ruby_constant'
 module RubyGemRelease
   module Workflow
     class Context
+      def configure!
+        raise ArgumentError, 'dry-run must be true or false' unless %w[true false].include?(ENV.fetch('DRY_RUN'))
+
+        names = %w[INPUT_VERSION INPUT_GEMSPEC DEFAULT_BRANCH DRY_RUN GIT_USER_NAME GIT_USER_EMAIL RUBYGEMS_OWNER]
+        export(names.to_h { |name| [name, ENV.fetch(name)] })
+      end
+
       def capture!
         dry_run = ENV.fetch('DRY_RUN', 'false') == 'true'
         check_branch(dry_run)
@@ -57,10 +64,10 @@ module RubyGemRelease
       end
 
       def export(values)
+        raise ArgumentError, 'Workflow values cannot contain line breaks' if values.values.any? { |value| value.match?(/[\r\n]/) }
+
         File.open(ENV.fetch('GITHUB_ENV'), 'a') do |file|
           values.each do |key, value|
-            raise ArgumentError, 'Workflow values cannot contain line breaks' if value.match?(/[\r\n]/)
-
             file.puts "#{key}=#{value}"
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gem-release
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Doubrovkine