@graphcommerce/docs 6.2.0-canary.82 → 6.2.0-canary.84

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 6.2.0-canary.84
+
+## 6.2.0-canary.83
+
 ## 6.2.0-canary.82
 
 ## 6.2.0-canary.81

package/framework/config.md

@@ -183,6 +183,10 @@ The Google Tagmanager ID to be used on the site.
 
 This value is required even if you are configuring different values for each locale.
 
+#### `hygraphProjectId: String`
+
+Hygraph Project ID. **Only used for migrations.**
+
 #### `hygraphWriteAccessEndpoint: String`
 
 Content API. **Only used for migrations.**
@@ -210,6 +214,12 @@ Project settings -> API Access -> Permanent Auth Tokens
   - Delete existing components
   - Update remote sources
   - Delete remote sources
+  - Read existing environments
+  - Read public content views
+  - Create public content views
+  - Update public content views
+  - Delete public content views
+  - Can see schema view
 
 ```
 GC_HYGRAPH_WRITE_ACCESS_ENDPOINT="https://...hygraph.com/v2/..."

package/hygraph/cli.md

@@ -0,0 +1,63 @@
+---
+menu: Hygraph cli
+---
+
+# Hygraph migrate cli
+
+It is possible to upgrade your Hygraph schema using the Graphcommerce Hygraph
+CLI: `yarn graphcommerce hygraph-migrate`
+
+This is a tool that automatically modifies your Hygraph schema without having to
+add models, components field and enumerations manually.
+
+Please note that:
+
+- All migrations are backwards compatible with previous versions of
+  GraphCommerce. This means that after running a migration, older versions of
+  GraphCommerce will still work (unless specified otherwise)
+
+- There is no rollback functionality in the Hygraph migrate cli. Please create a
+  copy of the project to test te migration on first. Once you run a migration,
+  you can't undo these schema changes with the CLI. You will be required
+  rollback the from the UI yourself.
+
+### Steps
+
+The following steps are needed to utilize this tool:
+
+1. Create a Hygraph migration token
+   1. Open your Hygraph project. Go to: Project settings > Permanent auth tokens
+   2. Click 'Add token' and give it a name, something like 'GraphCommerce Write
+      Access Token' and keep stage on 'Published'.
+   3. Under 'Management API', click 'Yes, Initialize defaults'
+   4. Click 'Edit Permissions' and enable: 'Update' and 'Delete' permissions for
+      'models', 'enumerations', 'fields', 'components' and 'sources':
+      - Update existing models
+      - Delete existing models
+      - Update existing fields
+      - Delete existing fields
+      - Update existing enumerations
+      - Delete existing enumerations
+      - Update existing components
+      - Delete existing components
+      - Update remote sources
+      - Delete remote sources
+      - Read existing environments
+      - Read public content views
+      - Create public content views
+      - Update public content views
+      - Delete public content views
+      - Can see schema view
+   5. Add this new token to your env file: `GC_HYGRAPH_WRITE_ACCESS_TOKEN=""`
+2. Add the Content API key to your env file like this:
+   1. Open your Hygraph project. Go to: Project settings -> API Access
+   2. Copy the Content API URL and add to your env file:
+      `GC_HYGRAPH_WRITE_ACCESS_ENDPOINT=""`
+3. Add your hygraphProjectId to your env file like this:
+   1. Copy the project ID from the URL when logged in
+      `https://app.hygraph.com/PROJECT_ID_IS_HERE/master`
+   2. Add the project ID to your env file: `GC_HYGRAPH_PROJECT_ID=””`
+4. Run `yarn graphcommerce hygraph-migrate`
+5. Select the migration you want to run and press enter.
+6. The migrations should now be applied, check your Hygraph Schema if changes
+   are made.

package/{framework/graphcms.md → hygraph/readme.md}

@@ -1,5 +1,5 @@
 ---
-menu: Hygraph
+menu: Overview
 ---
 
 # Hygraph
@@ -66,3 +66,4 @@ Is used to add a`RowProduct (variant:Grid)` and a
 
 - Learn how to
   [build a custom Hygraph component](../getting-started/graphcms-component.md)
+  - Learn how to [upgrade your Hygraph schema](./upgrading.md)

package/package.json

@@ -2,10 +2,10 @@
   "name": "@graphcommerce/docs",
   "homepage": "https://www.graphcommerce.org/docs",
   "repository": "github:graphcommerce-org/graphcommerce/docs",
-  "version": "6.2.0-canary.82",
+  "version": "6.2.0-canary.84",
   "sideEffects": true,
   "devDependencies": {
-    "@graphcommerce/prettier-config-pwa": "6.2.0-canary.82"
+    "@graphcommerce/prettier-config-pwa": "6.2.0-canary.84"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }

package/upgrading/{graphcommerce-6-1-to-6-2.md → graphcommerce-6-to-7.md}

@@ -1,11 +1,13 @@
-# Upgrading from GraphCommerce 6.1 to 6.2
+# Upgrading from GraphCommerce 6 to 7
 
-Upgrading from GraphCommerce 6.1 to 6.2 is minor update. Depending on the
-amounts of customisations you've made, there are some manual steps. Please
-follow the regular [upgrade steps first](./readme.md).
+Depending on the amounts of customisations you've made, there are some manual
+steps. Please follow the regular [upgrade steps first](./readme.md).
 
 1. [Add `fetchPolicy: cache-first` to LayoutDocument](#add-cache-first-fetchpolicy-to-layoutdocument)
-2. [Translation file updates](#translation-file-updates)
+2. [Use thew new `hygraphPageContent` function instead of DefaultPageQuery](#use-the-new-hygraphpagecontent-function-instead-of-defaultpagequery)
+3. [Translation file updates](#translation-file-updates)
+4. [All @graphql-mesh/\* should be set to latest](#all-graphql-mesh-should-be-set-to-latest)
+5. [Upgrading your Hygraph schema](#upgrading-your-hygraph-schema)
 
 ## Add `fetchPolicy: cache-first` to LayoutDocument queries
 
@@ -22,7 +24,7 @@ staticClient.query({ query: LayoutDocument })
 staticClient.query({ query: LayoutDocument, fetchPolicy: 'cache-first' })
 ```
 
-## Use thew new `hygraphPageContent` function instead of DefaultPageQuery
+## Use the new `hygraphPageContent` function instead of DefaultPageQuery
 
 🟠 Only required if you've added custom pages
 
@@ -87,3 +89,8 @@ In your package.json
     "@graphql-mesh/json-schema": "latest",
     "@graphql-mesh/transform-filter-schema": "latest",
 ```
+
+## Upgrading your Hygraph schema
+
+Upgrade your Hygraph schema with the [Hygraph migration cli](../hygraph/cli.md).
+Select `graphcommerce6to7` as version.

package/upgrading/readme.md

@@ -107,7 +107,7 @@ find . -type f -name '*.rej' -delete
 After resolving the diff issues, manually process upgrade instructions:
 
 - [Upgrading to GraphCommerce 5 to 6](../upgrading/graphcommerce-5-to-6.md)
-- [Upgrading to GraphCommerce 6.1 to 6.2](../upgrading/graphcommerce-6-1-to-6-2.md)
+- [Upgrading to GraphCommerce 6 to 7](../upgrading/graphcommerce-6-to-7.md)
 
 Run and validate your local environment: