asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: updates for next release (#14275)

Browse Source
This commit is contained in:
Shahed Nasser
2025-12-11 15:56:34 +02:00
committed by GitHub
parent 920d002288
commit 62c637d709
5 changed files with 235 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
www/apps/book/app/learn/deployment/general/page.mdx
View File

@@ -171,7 +171,9 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/workflow-engine-redis",
options: {
redis: {
url: process.env.REDIS_URL,
// Note: This was `url` before v2.12.2
// It's now deprecated in favor of `redisUrl`
redisUrl: process.env.REDIS_URL,
},
},
},

2
www/apps/book/generated/edit-dates.mjs
View File

@@ -94,7 +94,7 @@ export const generatedEditDates = {
"app/learn/fundamentals/custom-cli-scripts/seed-data/page.mdx": "2025-09-15T16:02:51.362Z",
"app/learn/fundamentals/environment-variables/page.mdx": "2025-11-26T11:05:38.863Z",
"app/learn/build/page.mdx": "2025-10-27T09:30:26.957Z",
"app/learn/deployment/general/page.mdx": "2025-10-21T07:39:08.998Z",
"app/learn/deployment/general/page.mdx": "2025-12-11T06:45:25.632Z",
"app/learn/fundamentals/workflows/multiple-step-usage/page.mdx": "2025-08-01T14:59:59.501Z",
"app/learn/installation/page.mdx": "2025-12-04T14:30:00.510Z",
"app/learn/fundamentals/data-models/check-constraints/page.mdx": "2025-07-25T13:50:21.065Z",

22
www/apps/book/public/llms-full.txt
View File

@@ -7943,7 +7943,9 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/workflow-engine-redis",
options: {
redis: {
url: process.env.REDIS_URL,
// Note: This was `url` before v2.12.2
// It's now deprecated in favor of `redisUrl`
redisUrl: process.env.REDIS_URL,
},
},
},
@@ -48157,7 +48159,8 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/workflow-engine-redis",
options: {
redis: {
url: process.env.WE_REDIS_URL,
redisUrl: process.env.WE_REDIS_URL,
// ...other Redis options
},
},
},
@@ -48178,9 +48181,20 @@ WE_REDIS_URL=<YOUR_REDIS_URL>
|Option|Description|Required|Default|
|---|---|---|---|---|---|---|
|\`url\`|A string indicating the Redis connection URL.|No. If not provided, you must provide the |-|
|\`options\`|An object of Redis options. Refer to the |No|-|
|\`queueName\`|The name of the queue used to keep track of retries and timeouts.|No|\`medusa-workflows\`|
|\`redisUrl\`|A string indicating the Redis connection URL.|No. If not provided, you must provide the |-|
|\`pubsub\`|A connection object having the following properties:|No. If not provided, you must provide the |-|
|\`queueName\`|The name of the queue used to keep track of retries and timeouts for workflow executions.|No|\`medusa-workflows\`|
|\`jobQueueName\`|The name of the queue used to keep track of retries and timeouts for scheduled jobs.|No|\`medusa-workflows-jobs\`|
|\`options\`|An object of Redis options. Refer to the |No|-|
|\`redisOptions\`|An object of Redis options. Refer to the |No|-|
|\`queueOptions\`|An object of options to pass to all BullMQ instances. Refer to |No|-|
|\`workerOptions\`|An object of options to pass to all BullMQ worker instances. Refer to |No|-|
|\`mainQueueOptions\`|An object of options to pass to the main BullMQ queue instance for workflows. Refer to |No|-|
|\`mainWorkerOptions\`|An object of options to pass to the main BullMQ worker instance for workflows. Refer to |No|-|
|\`jobQueueOptions\`|An object of options to pass to the main BullMQ workflow queue instance for scheduled jobs. Refer to |No|-|
|\`jobWorkerOptions\`|An object of options to pass to the main BullMQ workflow worker instance for scheduled jobs. Refer to |No|-|
|\`cleanerQueueOptions\`|An object of options to pass to the BullMQ cleaner queue instance. Refer to |No|-|
|\`cleanerWorkerOptions\`|An object of options to pass to the BullMQ cleaner worker instance. Refer to |No|-|
## Test the Module

251
www/apps/resources/app/infrastructure-modules/workflow-engine/redis/page.mdx
View File

@@ -43,7 +43,8 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/workflow-engine-redis",
options: {
redis: {
url: process.env.WE_REDIS_URL,
redisUrl: process.env.WE_REDIS_URL,
// ...other Redis options
},
},
},
@@ -67,14 +68,13 @@ WE_REDIS_URL=<YOUR_REDIS_URL>
<Table.HeaderCell>Option</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Required</Table.HeaderCell>
<Table.HeaderCell>Default</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`url`
`url` (Deprecated v2.12.2+, use `redisUrl` instead)
</Table.Cell>
<Table.Cell>
@@ -86,54 +86,22 @@ WE_REDIS_URL=<YOUR_REDIS_URL>
No. If not provided, you must provide the `pubsub` option.
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`options`
`redisUrl` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of Redis options. Refer to the [Redis API Reference](https://redis.github.io/ioredis/index.html#RedisOptions) for details on accepted properties.
A string indicating the Redis connection URL.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`queueName`
</Table.Cell>
<Table.Cell>
The name of the queue used to keep track of retries and timeouts.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
<Table.Cell>
`medusa-workflows`
No. If not provided, you must provide the `pubsub` option.
</Table.Cell>
</Table.Row>
@@ -156,9 +124,214 @@ WE_REDIS_URL=<YOUR_REDIS_URL>
No. If not provided, you must provide the `url` option.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
\-
`queueName`
</Table.Cell>
<Table.Cell>
The name of the queue used to keep track of retries and timeouts for workflow executions.
Default: `medusa-workflows`
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`jobQueueName`
</Table.Cell>
<Table.Cell>
The name of the queue used to keep track of retries and timeouts for scheduled jobs.
Default: `medusa-workflows-jobs`
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`options` (deprecated v2.12.2+, use `redisOptions` instead)
</Table.Cell>
<Table.Cell>
An object of Redis options. Refer to the [Redis API Reference](https://redis.github.io/ioredis/index.html#RedisOptions) for details on accepted properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`redisOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of Redis options. Refer to the [Redis API Reference](https://redis.github.io/ioredis/index.html#RedisOptions) for details on accepted properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`queueOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of options to pass to all BullMQ instances. Refer to [BullMQ's API reference](https://api.docs.bullmq.io/interfaces/v5.QueueOptions.html) for allowed properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`workerOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of options to pass to all BullMQ worker instances. Refer to [BullMQ's API reference](https://api.docs.bullmq.io/interfaces/v5.WorkerOptions.html) for allowed properties.
You can instead set options per worker using the `mainWorkerOptions`, `jobWorkerOptions`, and `cleanerWorkerOptions` options.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`mainQueueOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of options to pass to the main BullMQ queue instance for workflows. Refer to [BullMQ's API reference](https://api.docs.bullmq.io/interfaces/v5.QueueOptions.html) for allowed properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`mainWorkerOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of options to pass to the main BullMQ worker instance for workflows. Refer to [BullMQ's API reference](https://api.docs.bullmq.io/interfaces/v5.WorkerOptions.html) for allowed properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`jobQueueOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of options to pass to the main BullMQ workflow queue instance for scheduled jobs. Refer to [BullMQ's API reference](https://api.docs.bullmq.io/interfaces/v5.QueueOptions.html) for allowed properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`jobWorkerOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of options to pass to the main BullMQ workflow worker instance for scheduled jobs. Refer to [BullMQ's API reference](https://api.docs.bullmq.io/interfaces/v5.WorkerOptions.html) for allowed properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`cleanerQueueOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of options to pass to the BullMQ cleaner queue instance. Refer to [BullMQ's API reference](https://api.docs.bullmq.io/interfaces/v5.QueueOptions.html) for allowed properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`cleanerWorkerOptions` (v2.12.2+)
</Table.Cell>
<Table.Cell>
An object of options to pass to the BullMQ cleaner worker instance. Refer to [BullMQ's API reference](https://api.docs.bullmq.io/interfaces/v5.WorkerOptions.html) for allowed properties.
</Table.Cell>
<Table.Cell>
No
</Table.Cell>
</Table.Row>

2
www/apps/resources/generated/edit-dates.mjs
View File

@@ -194,7 +194,7 @@ export const generatedEditDates = {
"app/commerce-modules/api-key/page.mdx": "2025-04-17T08:48:16.605Z",
"app/commerce-modules/auth/create-actor-type/page.mdx": "2025-05-20T07:51:40.707Z",
"app/infrastructure-modules/page.mdx": "2025-05-21T13:01:59.821Z",
"app/infrastructure-modules/workflow-engine/redis/page.mdx": "2025-06-24T08:50:10.115Z",
"app/infrastructure-modules/workflow-engine/redis/page.mdx": "2025-12-11T06:49:22.621Z",
"app/infrastructure-modules/notification/sendgrid/page.mdx": "2025-09-10T12:12:04.142Z",
"app/commerce-modules/api-key/concepts/page.mdx": "2025-08-01T15:40:51.530Z",
"app/infrastructure-modules/workflow-engine/page.mdx": "2025-04-17T08:29:00.881Z",