Skip to content

Commit 5777e59

Browse files
committed
chore: add 1.1.0 migration guide
1 parent 75f9608 commit 5777e59

File tree

3 files changed

+77
-0
lines changed

3 files changed

+77
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# 1.1.0 Backward incompatible changes reference
2+
3+
In this document, you can see crucial breaking changes in the `1.1.0` compared to `1.0.2` release. To see all changes, please take a look at [the release pull request.](https://github.com/vuestorefront/magento2/pull/1355)
4+
5+
## feat!: implement Magento URL rewrites
6+
7+
[https://github.com/vuestorefront/magento2/pull/1321/files](https://github.com/vuestorefront/magento2/pull/1321)
8+
9+
| File | What was changed |
10+
|--------------------------------------------------------------------------------------------| --- |
11+
| **[!]** packages/theme/middleware/url-resolver.ts | A new, rewrite-aware URL resolver is added. |
12+
| **[!]** packages/theme/modules/catalog/index.ts | Routes configuration is removed. |
13+
| **[!]** packages/theme/stores/page.ts | Add Pinia PageStore to store route data state for pages. |
14+
| packages/api-client/src/api/route/route.ts | The query data structure is modified: relative_url and redirect_code are removed. |
15+
| packages/theme/composables/useUiHelpers/index.ts | The category prefix is removed from the category URL string. |
16+
| packages/theme/modules/catalog/category/helpers/useTraverseCategory.ts | The category prefix is removed from the category URL string. |
17+
| packages/theme/modules/catalog/product/composables/useProduct/useProduct.ts | Add getProductPath method. Get a product path from url_rewrites or url_key. |
18+
| packages/theme/helpers/cart/addToCart.ts | GroupedProduct’s add-to-cart URL resolution is simplified and replaced with the getProductPath. |
19+
| packages/theme/modules/catalog/category/components/views/useProductsWithCommonCardProps.ts | Product link URL resolution is simplified and replaced with the getProductPath. |
20+
| packages/theme/modules/customer/pages/MyAccount/MyWishlist.vue | Product link URL resolution is simplified and replaced with the getProductPath. |
21+
| packages/theme/modules/catalog/product/components/ProductsCarousel.vue | Product link URL resolution is simplified and replaced with the getProductPath. |
22+
| packages/theme/modules/GraphQL/types.ts | Add missing optional fields on the RoutableInterface |
23+
24+
***Notes:*** If you are using in your project old, prefixed URL or URL resolvers, replace them with the usage of the new **useProduct::getProductPath**
25+
26+
***Notes:*** The old routing system is replaced with a Magento route **type** resolver. Previously, VSF was able to route to a CMS, Category, or Product page based on the URL prefix. Currently, the renderer type is resolved based on the GraphQL **route** query and the route **type** field.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Vue Storefront for Magento 1.1.0
2+
3+
Vue Storefront for Magento 1.1.0 contains backward-incompatible changes. To review these backward-incompatible changes, see
4+
5+
[1.1.0 **Backward incompatible changes reference** ](./1.1.0-bic.md)
6+
7+
## Vue Storefront for Magento 1.1.0 highlights
8+
9+
Vue Storefront for Magento 1.1.0 provides a few new features like SEO-friendly URLs, SEO meta tags, Google Cloud CDN support, and more.
10+
11+
## Features
12+
13+
- feat!: implement magento URL rewrites [https://github.com/vuestorefront/magento2/pull/1321](https://github.com/vuestorefront/magento2/pull/1321/files)
14+
- feat: add GC CDN support [https://github.com/vuestorefront/magento2/pull/1338](https://github.com/vuestorefront/magento2/pull/1338)
15+
- feat: implement a meta info on cms, product,category page [https://github.com/vuestorefront/magento2/pull/1326](https://github.com/vuestorefront/magento2/pull/1326)
16+
- feat: implement add a grouped product to cart [https://github.com/vuestorefront/magento2/pull/1324](https://github.com/vuestorefront/magento2/pull/1324)
17+
- feat: make security connection optional by default [https://github.com/vuestorefront/magento2/pull/1354](https://github.com/vuestorefront/magento2/pull/1354)
18+
19+
### Bugfix
20+
21+
- fix: product list page is sometimes unresponsive after the store switch [https://github.com/vuestorefront/magento2/pull/1352](https://github.com/vuestorefront/magento2/pull/1352)
22+
- fix: logout doesn't work after reload of the MyAccount page [https://github.com/vuestorefront/magento2/pull/1347](https://github.com/vuestorefront/magento2/pull/1347)
23+
- fix: pods do not get up after deployment [https://github.com/vuestorefront/magento2/pull/1351](https://github.com/vuestorefront/magento2/pull/1351)
24+
- fix: add missing canary URL protocols [https://github.com/vuestorefront/magento2/pull/1349](https://github.com/vuestorefront/magento2/pull/1349)
25+
- fix: product is not marked as added to the wishlist [https://github.com/vuestorefront/magento2/pull/1346](https://github.com/vuestorefront/magento2/pull/1346)
26+
- fix: fix the issue with a store switching on the customer account [https://github.com/vuestorefront/magento2/pull/1345](https://github.com/vuestorefront/magento2/pull/1345)
27+
- fix: fix a message about the submitted review [https://github.com/vuestorefront/magento2/pull/1331](https://github.com/vuestorefront/magento2/pull/1331)
28+
- fix: vsf2 not working with docker-compose [https://github.com/vuestorefront/magento2/pull/1337](https://github.com/vuestorefront/magento2/pull/1337)
29+
- fix: pods have warnings error after deployment [https://github.com/vuestorefront/magento2/pull/1335](https://github.com/vuestorefront/magento2/pull/1335)
30+
- fix: fix product detail components [https://github.com/vuestorefront/magento2/pull/1330](https://github.com/vuestorefront/magento2/pull/1330)
31+
- fix: downloadableProduct might not have been initialized [https://github.com/vuestorefront/magento2/pull/1325](https://github.com/vuestorefront/magento2/pull/1325)
32+
- fix: getAvailableShippingMethods query variables [https://github.com/vuestorefront/magento2/pull/1318](https://github.com/vuestorefront/magento2/pull/1318)
33+
34+
### Chore
35+
36+
- chore: removed deprecated composables packages from the repository [https://github.com/vuestorefront/magento2/pull/1322](https://github.com/vuestorefront/magento2/pull/1322)
37+
38+
### Docs
39+
40+
- docs: fixed breaking change reference link [https://github.com/vuestorefront/magento2/pull/1350](https://github.com/vuestorefront/magento2/pull/1350)
41+
- docs: fix wording + add installation video [https://github.com/vuestorefront/magento2/pull/1319](https://github.com/vuestorefront/magento2/pull/1319)
42+
43+
### Repository
44+
45+
- ci: fix code not checked out [https://github.com/vuestorefront/magento2/pull/1327](https://github.com/vuestorefront/magento2/pull/1327)
46+
- ci: refactor k6 action to add new env vars [https://github.com/vuestorefront/magento2/pull/1287](https://github.com/vuestorefront/magento2/pull/1287)
47+
48+
### Credits
49+
50+
Huge thanks to @[sethidden](https://github.com/sethidden), [@sequensucks](https://github.com/sequensucks), [@Frodigo](https://github.com/Frodigo), [@bartoszherba](https://github.com/bartoszherba)

docs/migration-guides/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Migration guides
22
## 1.0.x
3+
- [1.1.0](./1.1.0/)
34
- [1.0.2](./1.0.2/)
45
- [1.0.1](./1.0.1/)
56
- [1.0.0](./1.0.0/)

0 commit comments

Comments
 (0)