Skip to content

Commit

Permalink
Merge branch 'develop' into supernova/700
Browse files Browse the repository at this point in the history
  • Loading branch information
sirugh authored Mar 26, 2019
2 parents e97eead + 1272fe7 commit fb43b83
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions pwa-devdocs/src/technologies/magento-compatibility/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,29 @@ This page lists PWA Studio versions and their compatible Magento core version.
<!--
This table is generated automatically from the source code.
-->

{% include auto-generated/magento-compatibility.md %}

## What compatibility means

If you are working directly with the PWA Studio repository, make sure the version you are working with is compatible with your Magento backend.

GraphQL queries in Venia are a main source of incompatibility between versions.
Breaking GraphQL schema changes in Magento require an update to the GraphQL queries used in the Venia storefront.

## Incompatibility scenarios

- A developer has the latest PWA Studio, such as **2.1.0** or greater, but the `MAGENTO_BACKEND_URL` still points to a Magento 2 instance running **2.3.0**.
- A developer is running an older version of PWA Studio, such as **2.0.0**, but the `MAGENTO_BACKEND_URL` points to a Magento 2 instance running **2.3.1**.

## Compatibility checks

Since **2.1.0**, PWA Studio includes a query validation step during the build process.
This step reports on any GraphQL incompatibility it encounters.

## Solving compatibility issues

Developers have two options for solving compatibility issues:

- Upgrade or downgrade the PWA Studio version to match the Magento 2 backend version
- Upgrade or downgrade the backend Magento 2 version to match the PWA Studio version

0 comments on commit fb43b83

Please sign in to comment.