bake-releases 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbecf648accb93dc35262658f110862092f97ae21003c2bbb7d16a9679824fa
-  data.tar.gz: f2e1cad486e0f7b1fdc76b1d838b5ae5a59eb8e38c2abefb876d310076728a9a
+  metadata.gz: d70acb13cdf265f825f2f48727a0a588fa84bbbe2b20ad66515912ea2f808569
+  data.tar.gz: 66e5d779098dc41c1155977e5737420093e16ba39f53fd294a310767e213272c
 SHA512:
-  metadata.gz: e7bdebe3ededfbd080740eca2b6a2d052a375e4d92bdae838ef29842213a464bcfb28e4dcd7d6c104297101818b759bd31f315b13a05d4bee08f4b868aedabf5
-  data.tar.gz: d70d211bd13e3c033d725085b503f60bd587286d3709ae3b21500e77da01caf7e3767af57ddc826fa04a81d83902131f9550058f5cd2b1ebdd689c23d5b6e49c
+  metadata.gz: a53eb4ddb3774358a69fb1f30db783bff4d998c3d316abe5165efc7fc907c9142fd209f15e2e21143f2e8ef0ef0e3b9ef180fde72e6adaa8d23c4631d733f1cd
+  data.tar.gz: e142292944f19c1ea02c9b253ec58c8f497459cac206ca99b87cde5d682de7511f57fcf7a7c129e980ea8dc343d7b98abb697159483a068f56312b500af30b6c

data/bake/releases/github.rb

@@ -9,24 +9,23 @@
 # Uses the `gh` command-line tool to create the release.
 # Release notes are extracted from `releases.md` for the given version; if none are found, the release is created with empty notes.
 #
-# @parameter tag_name [String] The tag name of the release, e.g. "v1.2.3".
-def release(tag_name)
+# @parameter tag [String] The tag name of the release, e.g. "v1.2.3".
+def release(tag)
 	require "tempfile"
 	
 	repo = github_repo
-	notes = release_notes(tag_name.to_s)
+	notes = context["releases:notes"].call(tag.to_s)
 	
 	Tempfile.create(["release-notes", ".md"]) do |file|
 		file.write(notes || "")
 		file.flush
 		
 		system(
-			"gh", "release", "create", tag_name.to_s,
+			"gh", "release", "create", tag.to_s,
 			"--repo", repo,
-			"--title", tag_name.to_s,
-			"--notes-file", file.path,
-			"--clobber"
-		) or raise "Failed to create GitHub release for #{tag_name}"
+			"--title", tag.to_s,
+			"--notes-file", file.path
+		) or raise "Failed to create GitHub release for #{tag}"
 	end
 end
 
@@ -38,7 +37,7 @@ def github_repo
 	gemspec_path = Dir.glob(File.join(context.root, "*.gemspec")).first
 	raise "No gemspec found in #{context.root}" unless gemspec_path
 	
-	spec = Gem::Specification.load(gemspec_path)
+	spec = ::Gem::Specification.load(gemspec_path)
 	
 	source_uri = spec.metadata&.dig("source_code_uri") || spec.homepage
 	raise "No source_code_uri or homepage found in gemspec" unless source_uri
@@ -48,35 +47,3 @@ def github_repo
 	
 	match[:repo]
 end
-
-def release_notes(tag_name, path = File.join(context.root, "releases.md"))
-	return nil unless File.exist?(path)
-	
-	require "markly"
-	document = Markly.parse(File.read(path))
-	
-	header = document.find_header(tag_name)
-	return nil unless header
-	
-	fragment = Markly::Node.new(:document)
-	node = header.next
-	while node
-		break if node.type == :header && node.header_level <= header.header_level
-		next_node = node.next
-		fragment.append_child(node)
-		node = next_node
-	end
-	
-	return nil unless fragment.first_child
-	
-	offset = header.header_level - 1
-	if offset > 0
-		fragment.walk do |node|
-			if node.type == :header
-				node.header_level -= offset
-			end
-		end
-	end
-
-	fragment.to_markdown
-end

data/bake/releases.rb

@@ -1,7 +1,18 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2024-2026, by Samuel Williams.
+
+# Extract the Markdown notes for a release without publishing it.
+#
+# @parameter tag [String] The exact release heading, e.g. "v1.2.3".
+# @parameter path [String] The releases document. Defaults to releases.md in the project root.
+# @returns [String | Nil] The release notes, or nil if no notes exist.
+def notes(tag, path: self.releases_path)
+	require_relative "../lib/bake/releases"
+	
+	Bake::Releases.notes(tag, path: path)
+end
 
 # Update the 'Unreleased' section of the releases document with the given version number, if it exists.
 #

data/context/getting-started.md

@@ -44,6 +44,27 @@ end
 
 When you release your gem using `bake gem:release`, the "Unreleased" section will automatically be renamed to the version number (e.g., `## v1.2.3`).
 
+### Reading Release Notes
+
+Release automation can extract the notes for a specific version without creating a GitHub release:
+
+```ruby
+require "bake/releases"
+
+notes = Bake::Releases.notes("v1.2.3", path: "releases.md")
+```
+
+The tag must match the heading in the document, including the `v` prefix. The method returns Markdown without that heading and promotes nested headings relative to it. It returns `nil` when the file, heading, or section content is missing. It does not modify the file. The default path is `releases.md` in the current working directory; pass an explicit path to read from another checkout.
+
+The `releases:notes` Bake task returns the same Markdown string and uses `releases.md` in the project root by default:
+
+```bash
+$ bundle exec bake releases:notes v1.2.3
+$ bundle exec bake releases:notes v1.2.3 path=changes.md
+```
+
+When publishing or retrying a release, select its exact version and read from the release commit's checkout. The existing `releases:github:release` task uses the same API to populate GitHub release notes.
+
 ## Best Practices for Release Notes
 
 ### Format Guidelines

data/context/index.yaml

@@ -3,6 +3,8 @@
 ---
 description: Releases document management.
 metadata:
+  bug_tracker_uri: https://github.com/ioquatix/bake-releases/issues
+  changelog_uri: https://github.com/ioquatix/bake-releases/blob/main/releases.md
   documentation_uri: https://ioquatix.github.io/bake-releases/
   funding_uri: https://github.com/sponsors/ioquatix/
   source_code_uri: https://github.com/ioquatix/bake-releases.git

data/lib/bake/releases/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2024-2026, by Samuel Williams.
 
 module Bake
 	module Releases
-		VERSION = "0.5.3"
+		VERSION = "0.6.0"
 	end
 end

data/lib/bake/releases.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require_relative "releases/version"
+require "markly"
+
+# @namespace
+module Bake
+	# Read and manage release documentation.
+	module Releases
+		# Extract a release section as Markdown without changing the source file.
+		# The release heading is omitted and nested headings are promoted relative to it.
+		#
+		# @parameter tag [String] The exact release heading, e.g. "v1.2.3".
+		# @parameter path [String] The releases document, relative to the current working directory unless absolute.
+		# @returns [String | Nil] The release notes, or nil if the file, heading, or section content is missing.
+		def self.notes(tag, path: "releases.md")
+			return nil unless File.exist?(path)
+			
+			document = Markly.parse(File.read(path))
+			header = document.find_header(tag.to_s)
+			return nil unless header
+			
+			fragment = Markly::Node.new(:document)
+			node = header.next
+			while node
+				break if node.type == :header && node.header_level <= header.header_level
+				next_node = node.next
+				fragment.append_child(node)
+				node = next_node
+			end
+			
+			return nil unless fragment.first_child
+			
+			offset = header.header_level - 1
+			if offset > 0
+				fragment.walk do |node|
+					if node.type == :header
+						node.header_level -= offset
+					end
+				end
+			end
+			
+			fragment.to_markdown
+		end
+	end
+end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2024-2025, by Samuel Williams.  
+Copyright, 2024-2026, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -2,6 +2,14 @@
 
 Please see the [project releases](https://ioquatix.github.io/bake-releases/releases/index) for all releases.
 
+### v0.6.0
+
+  - Extract release notes without publishing using `Bake::Releases.notes` or the `releases:notes` Bake task.
+
+### v0.5.4
+
+  - Fix ambiguous constant name `Gem::Specification` -\> `::Gem::Specification`.
+
 ### v0.5.3
 
   - Don't strip whitespace from release notes.

data/releases.md

@@ -1,5 +1,13 @@
 # Releases
 
+## v0.6.0
+
+  - Extract release notes without publishing using `Bake::Releases.notes` or the `releases:notes` Bake task.
+
+## v0.5.4
+
+  - Fix ambiguous constant name `Gem::Specification` -\> `::Gem::Specification`.
+
 ## v0.5.3
 
   - Don't strip whitespace from release notes.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-releases
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -75,6 +75,7 @@ files:
 - bake/releases/github.rb
 - context/getting-started.md
 - context/index.yaml
+- lib/bake/releases.rb
 - lib/bake/releases/version.rb
 - license.md
 - readme.md
@@ -83,6 +84,8 @@ homepage: https://github.com/ioquatix/bake-releases
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/ioquatix/bake-releases/issues
+  changelog_uri: https://github.com/ioquatix/bake-releases/blob/main/releases.md
   documentation_uri: https://ioquatix.github.io/bake-releases/
   funding_uri: https://github.com/sponsors/ioquatix/
   source_code_uri: https://github.com/ioquatix/bake-releases.git
@@ -100,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Releases document management.
 test_files: []