bake-releases 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a93358e129807efef4429aabfa849b76b4a9af22c2d2b39903886169e6f3d2c8
-  data.tar.gz: c1cd78406a6af653d0cd1d95a19039f836bfb85c8cfa3cf9a98bf12f39741b9e
+  metadata.gz: 44c26d3c49f9192ff7d3a832c7113230ed4e8b05c94d52e5066221ab2d095d86
+  data.tar.gz: 03acf82d7290306cd93a580444c1103dc96b033018531a8c7fb68718cfde488f
 SHA512:
-  metadata.gz: 659a5910c5f299a9379392f95133447805e45280e727fc7f6ecf51857f26bc303f7f530b8309bb4da34fa65755a78126ceb63ec39fb66f5ff77e183ddd89ed74
-  data.tar.gz: 235f2f78a28a1d1bbe462c7a58c9f6ac585465d119f85785a8c9d835c3b927d0baac9ee0f63fc3cf06b778f8a966031aa5990801a78310da43a741b5e3e0f506
+  metadata.gz: 5beb888f70fcc85a794c1fd813accf4765c9f8710f0e54ee56b0faa14deaa9e1bc2ef84460edeb2dbb8a5a88a17323dbb43077dd0bb121abb392a80392d53077
+  data.tar.gz: b8f3a83b17a1aa185f87304411a3065adf68312ddbbc8182718193bbe78545a829b55251bef8206fb7503602a55a15a66b20dc6a82490236ece69aad141e8298

data/agent.md

@@ -0,0 +1,185 @@
+# Agent
+
+## Context
+
+This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`.
+
+**Important:** Before performing any code, documentation, or analysis tasks, always read and apply the full content of any relevant documentation referenced in the following sections. These context files contain authoritative standards and best practices for documentation, code style, and project-specific workflows. **Do not proceed with any actions until you have read and incorporated the guidance from relevant context files.**
+
+**Setup Instructions:** If the referenced files are not present or if dependencies have been updated, run `bake agent:context:install` to install the latest context files.
+
+### agent-context
+
+Install and manage context files from Ruby gems.
+
+#### [Getting Started](.context/agent-context/getting-started.md)
+
+This guide explains how to use `agent-context`, a tool for discovering and installing contextual information from Ruby gems to help AI agents.
+
+### async
+
+A concurrency framework for Ruby.
+
+#### [Getting Started](.context/async/getting-started.md)
+
+This guide shows how to add async to your project and run code asynchronously.
+
+#### [Scheduler](.context/async/scheduler.md)
+
+This guide gives an overview of how the scheduler is implemented.
+
+#### [Tasks](.context/async/tasks.md)
+
+This guide explains how asynchronous tasks work and how to use them.
+
+#### [Best Practices](.context/async/best-practices.md)
+
+This guide gives an overview of best practices for using Async.
+
+#### [Debugging](.context/async/debugging.md)
+
+This guide explains how to debug issues with programs that use Async.
+
+#### [Thread safety](.context/async/thread-safety.md)
+
+This guide explains thread safety in Ruby, focusing on fibers and threads, common pitfalls, and best practices to avoid problems like data corruption, race conditions, and deadlocks.
+
+### async-service
+
+A service layer for Async.
+
+#### [Getting Started](.context/async-service/getting-started.md)
+
+This guide explains how to get started with `async-service` to create and run services in Ruby.
+
+#### [Service Architecture](.context/async-service/service-architecture.md)
+
+This guide explains the key architectural components of `async-service` and how they work together to provide a clean separation of concerns.
+
+#### [Best Practices](.context/async-service/best-practices.md)
+
+This guide outlines recommended patterns and practices for building robust, maintainable services with `async-service`.
+
+### bake-gem
+
+Release management for Ruby gems.
+
+#### [Getting Started](.context/bake-gem/getting-started.md)
+
+This guide explains how to use `bake-gem` to release gems safely and efficiently.
+
+### decode
+
+Code analysis for documentation generation.
+
+#### [Getting Started with Decode](.context/decode/getting-started.md)
+
+The Decode gem provides programmatic access to Ruby code structure and metadata. It can parse Ruby files and extract definitions, comments, and documentation pragmas, enabling code analysis, documentation generation, and other programmatic manipulations of Ruby codebases.
+
+#### [Documentation Coverage](.context/decode/coverage.md)
+
+This guide explains how to test and monitor documentation coverage in your Ruby projects using the Decode gem's built-in bake tasks.
+
+#### [Ruby Documentation](.context/decode/ruby-documentation.md)
+
+This guide covers documentation practices and pragmas supported by the Decode gem for documenting Ruby code. These pragmas provide structured documentation that can be parsed and used to generate API documentation and achieve complete documentation coverage.
+
+#### [Setting Up RBS Types and Steep Type Checking for Ruby Gems](.context/decode/types.md)
+
+This guide covers the process for establishing robust type checking in Ruby gems using RBS and Steep, focusing on automated generation from source documentation and proper validation.
+
+### falcon
+
+A fast, asynchronous, rack-compatible web server.
+
+#### [Getting Started](.context/falcon/getting-started.md)
+
+This guide gives an overview of how to use Falcon for running Ruby web applications.
+
+#### [Rails Integration](.context/falcon/rails-integration.md)
+
+This guide explains how to host Rails applications with Falcon.
+
+#### [Deployment](.context/falcon/deployment.md)
+
+This guide explains how to deploy applications using the Falcon web server. It covers the recommended deployment methods, configuration options, and examples for different environments, including systemd and kubernetes.
+
+#### [Performance Tuning](.context/falcon/performance-tuning.md)
+
+This guide explains the performance characteristics of Falcon.
+
+#### [WebSockets](.context/falcon/websockets.md)
+
+This guide explains how to use WebSockets with Falcon.
+
+#### [Interim Responses](.context/falcon/interim-responses.md)
+
+This guide explains how to use interim responses in Falcon to send early hints to the client.
+
+#### [How It Works](.context/falcon/how-it-works.md)
+
+This guide gives an overview of how Falcon handles an incoming web request.
+
+### protocol-http
+
+Provides abstractions to handle HTTP protocols.
+
+#### [Getting Started](.context/protocol-http/getting-started.md)
+
+This guide explains how to use `protocol-http` for building abstract HTTP interfaces.
+
+#### [Message Body](.context/protocol-http/message-body.md)
+
+This guide explains how to work with HTTP request and response message bodies using `Protocol::HTTP::Body` classes.
+
+#### [Middleware](.context/protocol-http/middleware.md)
+
+This guide explains how to build and use HTTP middleware with `Protocol::HTTP::Middleware`.
+
+#### [Hypertext References](.context/protocol-http/hypertext-references.md)
+
+This guide explains how to use `Protocol::HTTP::Reference` for constructing and manipulating hypertext references (URLs with parameters).
+
+#### [URL Parsing](.context/protocol-http/url-parsing.md)
+
+This guide explains how to use `Protocol::HTTP::URL` for parsing and manipulating URL components, particularly query strings and parameters.
+
+#### [Streaming](.context/protocol-http/streaming.md)
+
+This guide gives an overview of how to implement streaming requests and responses.
+
+#### [Design Overview](.context/protocol-http/design-overview.md)
+
+This guide explains the high level design of `protocol-http` in the context of wider design patterns that can be used to implement HTTP clients and servers.
+
+### sus
+
+A fast and scalable test runner.
+
+#### [Using Sus Testing Framework](.context/sus/usage.md)
+
+Sus is a modern Ruby testing framework that provides a clean, BDD-style syntax for writing tests. It's designed to be fast, simple, and expressive.
+
+#### [Mocking](.context/sus/mocking.md)
+
+There are two types of mocking in sus: `receive` and `mock`. The `receive` matcher is a subset of full mocking and is used to set expectations on method calls, while `mock` can be used to replace method implementations or set up more complex behavior.
+
+#### [Shared Test Behaviors and Fixtures](.context/sus/shared.md)
+
+Sus provides shared test contexts which can be used to define common behaviours or tests that can be reused across one or more test files.
+
+### utopia-project
+
+A project documentation tool based on Utopia.
+
+#### [Getting Started](.context/utopia-project/getting-started.md)
+
+This guide explains how to use `utopia-project` to add documentation to your project.
+
+#### [Documentation Guides](.context/utopia-project/documentation-guidelines.md)
+
+This guide explains how to create and maintain documentation for your project using `utopia-project`.
+
+#### [GitHub Pages Integration](.context/utopia-project/github-pages-integration.md)
+
+This guide shows you how to use `utopia-project` with GitHub Pages to deploy documentation.

data/bake/releases/github.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+# Publish a GitHub release for the given version.
+#
+# Requires a `source_code_uri` or `homepage` pointing to `github.com` in the gemspec.
+# 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)
+	require "tempfile"
+	
+	repo = github_repo
+	notes = release_notes(tag_name.to_s)
+	
+	Tempfile.create(["release-notes", ".md"]) do |file|
+		file.write(notes || "")
+		file.flush
+		
+		system(
+			"gh", "release", "create", tag_name.to_s,
+			"--repo", repo,
+			"--title", tag_name.to_s,
+			"--notes-file", file.path,
+			"--clobber"
+		) or raise "Failed to create GitHub release for #{tag_name}"
+	end
+end
+
+private
+
+GITHUB_URI_PATTERN = %r{github\.com[:/]+(?<repo>[^/\s]+/[^/\s]+?)(?:\.git)?$}
+
+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)
+	
+	source_uri = spec.metadata&.dig("source_code_uri") || spec.homepage
+	raise "No source_code_uri or homepage found in gemspec" unless source_uri
+	
+	match = GITHUB_URI_PATTERN.match(source_uri)
+	raise "URI does not appear to be a GitHub repository: #{source_uri}" unless match
+	
+	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.strip
+end

data/bake/releases.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 # Update the 'Unreleased' section of the releases document with the given version number, if it exists.
 #

data/context/getting-started.md

@@ -36,7 +36,7 @@ $ bundle add bake-releases
 # bake.rb
 
 def after_gem_release_version_increment(version)
-	context['releases:update'].call(version)
+	context["releases:update"].call(version)
 end
 ```
 

data/lib/bake/releases/version.rb

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

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2024, by Samuel Williams.  
+Copyright, 2024-2025, 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,10 @@
 
 Please see the [project releases](https://ioquatix.github.io/bake-releases/releases/index) for all releases.
 
+### v0.5.0
+
+  - Add support for automatic GitHub release creation.
+
 ### v0.4.0
 
   - Add documentation and agent context.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.5.0
+
+  - Add support for automatic GitHub release creation.
+
 ## v0.4.0
 
   - Add documentation and agent context.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-releases
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -70,7 +70,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- agent.md
 - bake/releases.rb
+- bake/releases/github.rb
 - context/getting-started.md
 - context/index.yaml
 - lib/bake/releases/version.rb
@@ -91,14 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Releases document management.
 test_files: []