Skip to content

Commit 9da99da

Browse files
committed
Add releases and agent context.
1 parent c55164d commit 9da99da

File tree

7 files changed

+54
-1
lines changed

7 files changed

+54
-1
lines changed

bake.rb

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# frozen_string_literal: true
2+
3+
# Released under the MIT License.
4+
# Copyright, 2025, by Samuel Williams.
5+
6+
# Update the project documentation with the new version number.
7+
#
8+
# @parameter version [String] The new version number.
9+
def after_gem_release_version_increment(version)
10+
context["releases:update"].call(version)
11+
context["utopia:project:update"].call
12+
end

console-adapter-rails.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
2020
"source_code_uri" => "https://github.com/socketry/console-adapter-rails.git",
2121
}
2222

23-
spec.files = Dir.glob(["{lib}/**/*", "*.md"], File::FNM_DOTMATCH, base: __dir__)
23+
spec.files = Dir.glob(["{context,lib}/**/*", "*.md"], File::FNM_DOTMATCH, base: __dir__)
2424

2525
spec.required_ruby_version = ">= 3.2"
2626

context/getting-started.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Getting Started
2+
3+
This guide explains how to integrate the `console-adapter-rails` gem into your Rails application.
4+
5+
## Installation
6+
7+
Add the gem to your project:
8+
9+
~~~ bash
10+
$ bundle add console-adapter-rails
11+
~~~
12+
13+
The gem includes a Railtie that will set up all required logging configuration for you.
14+
15+
If you wish to log ActiveRecord, add `Console::Adapter::Rails::ActiveRecord.apply!` into your `config/environment.rb` file, before the `Rails.application.initialize!` call.

context/index.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Automatically generated context index for Utopia::Project guides.
2+
# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
3+
---
4+
description: Adapt Rails logs and events to the console gem.
5+
metadata:
6+
documentation_uri: https://socketry.github.io/console-adapter-rails/
7+
source_code_uri: https://github.com/socketry/console-adapter-rails.git
8+
files:
9+
- path: getting-started.md
10+
title: Getting Started
11+
description: This guide explains how to integrate the `console-adapter-rails` gem
12+
into your Rails application.

gems.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
group :maintenance, optional: true do
1212
gem "bake-gem"
1313
gem "bake-modernize"
14+
gem "bake-releases"
1415

1516
gem "agent-context"
1617

readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ Please see the [project documentation](https://socketry.github.io/console-adapte
1010

1111
- [Getting Started](https://socketry.github.io/console-adapter-rails/guides/getting-started/index) - This guide explains how to integrate the `console-adapter-rails` gem into your Rails application.
1212

13+
## Releases
14+
15+
Please see the [project releases](https://socketry.github.io/console-adapter-rails/releases/index) for all releases.
16+
17+
### v0.5.0
18+
19+
- Improved compatibilty with Rails 8+.
20+
1321
## Contributing
1422

1523
We welcome contributions to this project.

releases.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Releases
2+
3+
## v0.5.0
4+
5+
- Improved compatibilty with Rails 8+.

0 commit comments

Comments
 (0)