Skip to content

Commit 45a7092

Browse files
committed
Document more expectations about the queue_adapter
1 parent 8fea567 commit 45a7092

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,21 @@ to use one of the following queue adapters:
3737
`ActiveJob::Base.queue_adapter` is not in the above list, it will raise an exception
3838
and prevent your application from performing unsafe journaling.**
3939

40+
The following configurations are __not supported__ by Journaled:
41+
42+
```ruby
43+
config.active_job.enqueue_after_transaction_commit = :always
44+
config.active_job.enqueue_after_transaction_commit = true
45+
```
46+
47+
If you're using Rails 7.2 with the `:test` adapter, please use the following configuration:
48+
49+
```ruby
50+
config.active_job.enqueue_after_transaction_commit = :never
51+
```
52+
53+
This effectively became the default in Rails 8.0.
54+
4055
2. To integrate Journaled into your application, simply include the gem in your
4156
app's Gemfile.
4257

@@ -91,7 +106,7 @@ app's Gemfile.
91106
92107
Journaling provides a number of different configuation options that can be set in Ruby using an initializer. Those values are:
93108
94-
#### `Journaled.default_stream_name `
109+
#### `Journaled.default_stream_name`
95110
96111
This is described in the "Installation" section above, and is used to specify which stream name to use.
97112

0 commit comments

Comments
 (0)