Skip to content

Commit

Permalink
added upgrade guide for v1.3.6
Browse files Browse the repository at this point in the history
  • Loading branch information
shahednasser committed Aug 17, 2022
1 parent fb1105b commit 9c3c8cb
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/content/advanced/backend/upgrade-guides/1-3-6.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# v1.3.6

Following the addition of feature flags in version v1.3.3 and the addition of the Sales Channels API in v1.3.5, v1.3.6 introduces a data migration script that moves all products into the Default Sales Channel.

:::note

In version 1.3.6, Sales Channels are available but hidden behind feature flags. If you don’t have Sales Channels enabled, you don’t need to follow the steps detailed in this migration script.

:::

## Prerequisites

Before performing the actions mentioned in this guide, you must set the following environment variables:

```bash
TYPEORM_CONNECTION=postgres
TYPEORM_URL=<DATABASE_URL>
TYPEORM_LOGGING=true
TYPEORM_ENTITIES=./node_modules/@medusajs/medusa/dist/models/*.js
TYPEORM_MIGRATIONS=./node_modules/@medusajs/medusa/dist/migrations/*.js
```

These environment variables are used in the data migration scripts in this upgrade. Make sure to replace `<DATABASE_URL>` with your PostgreSQL database URL.

## Sales Channels

Sales Channels were introduced in v1.3.5 behind a feature flag. By enabling Sales Channels, developers and users can associate products and other entities with a specific Sales Channel.

However, if you upgraded Medusa to v1.3.5 and enabled Sales Channels, you must add every product to at least one Sales Channel manually. Otherwise, products can’t be added to carts in different Sales Channels.

v1.3.6 introduces a data migration script that automates this process for you by moving all your products into a default Sales Channel. This ensures that you can use the Sales Channels feature without it affecting the user experience in your store.

### Actions Required

If you’ve enabled Sales Channels, it’s essential to run the data migration script after upgrading your server and before starting your Medusa server:

```bash
node ./node_modules/@medusajs/medusa/dist/scripts/sales-channels-migration.js
```
5 changes: 5 additions & 0 deletions www/docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,11 @@ module.exports = {
id: "advanced/backend/upgrade-guides/1-3-0",
label: "v1.3.0"
},
{
type: "doc",
id: "advanced/backend/upgrade-guides/1-3-6",
label: "v1.3.6"
},
]
},
]
Expand Down

0 comments on commit 9c3c8cb

Please sign in to comment.