bake-releases 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: debab81fa4c1eca42611442b2d1c0e64af432513c2a558bc8e23ae25e284a509
-  data.tar.gz: 34a9f14e81f38da31588292d9c7a68d22db2a8efae6c0933343e0277ccd1175b
+  metadata.gz: a93358e129807efef4429aabfa849b76b4a9af22c2d2b39903886169e6f3d2c8
+  data.tar.gz: c1cd78406a6af653d0cd1d95a19039f836bfb85c8cfa3cf9a98bf12f39741b9e
 SHA512:
-  metadata.gz: 9655d3f0d11542464a01d88c572873923976e2ed9f2590e603953da4e18ec1877dd1cecdf6dad2209fc49b45a2ffb2d94c6ba126f324c66875ee254888f03828
-  data.tar.gz: 27aa6bc8c18c71b33062fee77d71fe6b04408e1c24c8d0c053df921b3c14e5c33b5688953e002ecfcb8e8426d7d7ded7bfb95109fa939f087d20bf5a5b56ef49
+  metadata.gz: 659a5910c5f299a9379392f95133447805e45280e727fc7f6ecf51857f26bc303f7f530b8309bb4da34fa65755a78126ceb63ec39fb66f5ff77e183ddd89ed74
+  data.tar.gz: 235f2f78a28a1d1bbe462c7a58c9f6ac585465d119f85785a8c9d835c3b927d0baac9ee0f63fc3cf06b778f8a966031aa5990801a78310da43a741b5e3e0f506

data/context/getting-started.md

@@ -0,0 +1,97 @@
+# Getting Started
+
+This guide explains how to use `bake-releases` to manage release documentation for your Ruby gem.
+
+## Installation
+
+Add the gem to your project:
+
+```bash
+$ bundle add bake-releases
+```
+
+## Core Concepts
+
+`bake-releases` manages a `releases.md` document that tracks changes to your Ruby gem over time. It integrates seamlessly with `bake-gem` to automatically update version numbers when releasing gems.
+
+## Usage
+
+### Initial Setup
+
+1. Create a `releases.md` file in your project root with the following structure:
+
+```markdown
+# Releases
+
+## Unreleased
+
+- New feature description here.
+- Changed behavior description here.
+- Bug fix description here.
+```
+
+2. Add release management to your `bake.rb` file:
+
+```ruby
+# bake.rb
+
+def after_gem_release_version_increment(version)
+	context['releases:update'].call(version)
+end
+```
+
+### Releasing Changes
+
+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`).
+
+## Best Practices for Release Notes
+
+### Format Guidelines
+
+- **Use `## Unreleased` section** for changes that haven't been released yet. The bake task automatically converts this to a versioned section when you release.
+
+- **Use `## v0.0.0` format** for released versions. This format is automatically generated by the bake task.
+
+- **Use `### Subsection`** for organizing more elaborate release notes within a version when needed (optional).
+
+### Content Guidelines
+
+- **Be concise but descriptive** - Users should understand the impact without reading code.
+- **Focus on user impact** - Describe what changed for the user, not implementation details.
+- **Focus on externally visible changes** - Only mention changes that affect users. Internal improvements like "Improving tests" or "Updating code" are uninteresting for release notes unless there is nothing else to report.
+- **Use active voice** - "Added support for..." rather than "Support was added for...".
+- **Use backticks for code elements** - Wrap class names, method names, file names, and other code elements in backticks (e.g., `ClassName`, `method_name`, `config.yml`).
+- **Link to issues/PRs when helpful** - Provides additional context for complex changes.
+- **Group related changes** - Multiple small fixes can be combined into one entry.
+
+### Example Structure
+
+```markdown
+# Releases
+
+## Unreleased
+
+- Support for custom release templates.
+- Integration with GitHub releases API.
+- Improved error messages for invalid markdown.
+- Fixed issue with nested header parsing.
+
+## v0.2.1
+
+- Fixed compatibility with Ruby 3.2.
+- Corrected timestamp formatting in release notes.
+
+## v0.2.0
+
+- New `releases:validate` task for checking format.
+- Support for custom release note templates.
+- **Breaking**: Renamed `update_releases` to `releases:update`.
+- Improved performance for large release documents.
+
+### Worker Pool Support
+
+This version introduces optional worker pool support for handling concurrent release operations:
+
+- Set `RELEASES_WORKER_POOL=true` to enable concurrent processing.
+- Reduces blocking when processing multiple release documents.
+```

data/context/index.yaml

@@ -0,0 +1,13 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Releases document management.
+metadata:
+  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
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use `bake-releases` to manage release documentation
+    for your Ruby gem.

data/lib/bake/releases/version.rb

@@ -5,6 +5,6 @@
 
 module Bake
 	module Releases
-		VERSION = "0.4.0"
+		VERSION = "0.4.2"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-releases
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -71,6 +71,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bake/releases.rb
+- context/getting-started.md
+- context/index.yaml
 - lib/bake/releases/version.rb
 - license.md
 - readme.md