Skip to content

Commit 19d4bbe

Browse files
committed
update changelog
1 parent 2401f7c commit 19d4bbe

File tree

3 files changed

+39
-19
lines changed

3 files changed

+39
-19
lines changed

CHANGELOG-13x.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [Unreleased](https://github.com/vyuldashev/laravel-queue-rabbitmq/compare/v13.0.0...master)
6+
7+
## [13.0.0 (2022-09-15)](https://github.com/vyuldashev/laravel-queue-rabbitmq/compare/v12.0.1...v13.0.0)
8+
9+
- Dispatch a job after DB transaction commit [#468](https://github.com/vyuldashev/laravel-queue-rabbitmq/pull/468)

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,9 @@ RabbitMQ Queue driver for Laravel
1010

1111
Only the latest version will get new features. Bug fixes will be provided using the following scheme:
1212

13-
| Package Version | Laravel Version | Bug Fixes Until | |
14-
|-----------------|-----------------|---------------------|---------------------------------------------------------------------------------------------|
15-
| 9 | 6 | October 5th, 2021 | [Documentation](https://github.com/vyuldashev/laravel-queue-rabbitmq/blob/v9.0/README.md) |
16-
| 10 | 6, 7 | October 5th, 2021 | [Documentation](https://github.com/vyuldashev/laravel-queue-rabbitmq/blob/v10.0/README.md) |
17-
| 11 | 8 | April 6th, 2021 | [Documentation](https://github.com/vyuldashev/laravel-queue-rabbitmq/blob/master/README.md) |
13+
| Package Version | Laravel Version | Bug Fixes Until | |
14+
|-----------------|-----------------|------------------|---------------------------------------------------------------------------------------------|
15+
| 13 | 9 | August 8th, 2023 | [Documentation](https://github.com/vyuldashev/laravel-queue-rabbitmq/blob/master/README.md) |
1816

1917
## Installation
2018

@@ -74,10 +72,11 @@ Add connection to `config/queue.php`:
7472

7573
### Optional Config
7674

77-
Optionally add queue options to the config of a connection.
75+
Optionally add queue options to the config of a connection.
7876
Every queue created for this connection, get's the properties.
7977

8078
When you want to prioritize messages when they were delayed, then this is possible by adding extra options.
79+
8180
- When max-priority is omitted, the max priority is set with 2 when used.
8281

8382
```php
@@ -102,12 +101,13 @@ When you want to prioritize messages when they were delayed, then this is possib
102101
```
103102

104103
When you want to publish messages against an exchange with routing-key's, then this is possible by adding extra options.
104+
105105
- When the exchange is omitted, RabbitMQ will use the `amq.direct` exchange for the routing-key
106106
- When routing-key is omitted the routing-key by default is the `queue` name.
107107
- When using `%s` in the routing-key the queue_name will be substituted.
108108

109109
> Note: when using exchange with routing-key, u probably create your queues with bindings yourself.
110-
110+
111111
```php
112112
'connections' => [
113113
// ...
@@ -130,14 +130,18 @@ When you want to publish messages against an exchange with routing-key's, then t
130130
],
131131
```
132132

133-
In Laravel failed jobs are stored into the database. But maybe you want to instruct some other process to also do something with the message.
134-
When you want to instruct RabbitMQ to reroute failed messages to a exchange or a specific queue, then this is possible by adding extra options.
133+
In Laravel failed jobs are stored into the database. But maybe you want to instruct some other process to also do
134+
something with the message.
135+
When you want to instruct RabbitMQ to reroute failed messages to a exchange or a specific queue, then this is possible
136+
by adding extra options.
137+
135138
- When the exchange is omitted, RabbitMQ will use the `amq.direct` exchange for the routing-key
136139
- When routing-key is omitted, the routing-key by default the `queue` name is substituted with `'.failed'`.
137140
- When using `%s` in the routing-key the queue_name will be substituted.
138141

139-
> Note: When using failed_job exchange with routing-key, u probably need to create your exchange/queue with bindings yourself.
140-
142+
> Note: When using failed_job exchange with routing-key, u probably need to create your exchange/queue with bindings
143+
> yourself.
144+
141145
```php
142146
'connections' => [
143147
// ...
@@ -161,12 +165,14 @@ When you want to instruct RabbitMQ to reroute failed messages to a exchange or a
161165
```
162166

163167
### Use your own RabbitMQJob class
168+
164169
Sometimes you have to work with messages published by another application.
165170
Those messages probably won't respect Laravel's job payload schema.
166-
The problem with these messages is that, Laravel workers won't be able to determine the actual job or class to execute.
171+
The problem with these messages is that, Laravel workers won't be able to determine the actual job or class to execute.
167172

168173
You can extend the build-in `RabbitMQJob::class` and within the queue connection config, you can define your own class.
169-
When you specify an `job` key in the config, with your own class name, every message retrieved from the broker will get wrapped by your own class.
174+
When you specify an `job` key in the config, with your own class name, every message retrieved from the broker will get
175+
wrapped by your own class.
170176

171177
An example for the config:
172178

@@ -250,11 +256,14 @@ class RabbitMQJob extends BaseJob
250256

251257
## Laravel Usage
252258

253-
Once you completed the configuration you can use Laravel Queue API. If you used other queue drivers you do not need to change anything else. If you do not know how to use Queue API, please refer to the official Laravel documentation: http://laravel.com/docs/queues
259+
Once you completed the configuration you can use Laravel Queue API. If you used other queue drivers you do not need to
260+
change anything else. If you do not know how to use Queue API, please refer to the official Laravel
261+
documentation: http://laravel.com/docs/queues
254262

255263
## Laravel Horizon Usage
256264

257-
Starting with 8.0, this package supports [Laravel Horizon](http://horizon.laravel.com) out of the box. Firstly, install Horizon and then set `RABBITMQ_WORKER` to `horizon`.
265+
Starting with 8.0, this package supports [Laravel Horizon](http://horizon.laravel.com) out of the box. Firstly, install
266+
Horizon and then set `RABBITMQ_WORKER` to `horizon`.
258267

259268
## Lumen Usage
260269

@@ -266,11 +275,12 @@ $app->register(VladimirYuldashev\LaravelQueueRabbitMQ\LaravelQueueRabbitMQServic
266275

267276
## Consuming Messages
268277

269-
There are two ways of consuming messages.
278+
There are two ways of consuming messages.
270279

271280
1. `queue:work` command which is Laravel's built-in command. This command utilizes `basic_get`.
272281

273-
2. `rabbitmq:consume` command which is provided by this package. This command utilizes `basic_consume` and is more performant than `basic_get` by ~2x.
282+
2. `rabbitmq:consume` command which is provided by this package. This command utilizes `basic_consume` and is more
283+
performant than `basic_get` by ~2x.
274284

275285
## Testing
276286

@@ -302,4 +312,5 @@ composer fix:style
302312

303313
## Contribution
304314

305-
You can contribute to this package by discovering bugs and opening issues. Please, add to which version of package you create pull request or issue. (e.g. [5.2] Fatal error on delayed job)
315+
You can contribute to this package by discovering bugs and opening issues. Please, add to which version of package you
316+
create pull request or issue. (e.g. [5.2] Fatal error on delayed job)

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
},
3434
"extra": {
3535
"branch-alias": {
36-
"dev-master": "11.0-dev"
36+
"dev-master": "13.0-dev"
3737
},
3838
"laravel": {
3939
"providers": [

0 commit comments

Comments
 (0)