Skip to content

Commit 2d665fa

Browse files
authored
Merge pull request #6464 from Shopify/update-cli-hydrogen-11.1.4
hydrogen/Bump cli-hydrogen to 11.1.5 (main)
2 parents d8a6b7c + 11e81e1 commit 2d665fa

File tree

7 files changed

+158
-167
lines changed

7 files changed

+158
-167
lines changed

docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ export interface hydrogendeploy {
4848
*/
4949
'-f, --force'?: ''
5050

51+
/**
52+
* Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.
53+
* @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP
54+
*/
55+
'--force-client-sourcemap'?: ''
56+
5157
/**
5258
* Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.
5359
*

docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ export interface hydrogendev {
1212
*/
1313
'--codegen-config-path <value>'?: string
1414

15+
/**
16+
* Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow
17+
* @environment SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH
18+
*/
19+
'--customer-account-push'?: ''
20+
1521
/**
1622
* Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.
1723
* @environment SHOPIFY_HYDROGEN_FLAG_DEBUG

docs-shopify.dev/generated/generated_docs_data.json

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3186,6 +3186,15 @@
31863186
"description": "Path to an environment file to override existing environment variables for the deployment.",
31873187
"isOptional": true
31883188
},
3189+
{
3190+
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
3191+
"syntaxKind": "PropertySignature",
3192+
"name": "--force-client-sourcemap",
3193+
"value": "\"\"",
3194+
"description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.",
3195+
"isOptional": true,
3196+
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP"
3197+
},
31893198
{
31903199
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
31913200
"syntaxKind": "PropertySignature",
@@ -3274,7 +3283,7 @@
32743283
"environmentValue": "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN"
32753284
}
32763285
],
3277-
"value": "export interface hydrogendeploy {\n /**\n * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.\n * @environment AUTH_BYPASS_TOKEN\n */\n '--auth-bypass-token'?: ''\n\n /**\n * Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`\n * @environment AUTH_BYPASS_TOKEN_DURATION\n */\n '--auth-bypass-token-duration <value>'?: string\n\n /**\n * Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.\n *\n */\n '--build-command <value>'?: string\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch <value>'?: string\n\n /**\n * Path to an environment file to override existing environment variables for the deployment.\n *\n */\n '--env-file <value>'?: string\n\n /**\n * Forces a deployment to proceed if there are uncommited changes in its Git repository.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.\n *\n */\n '--json-output'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION\n */\n '--metadata-description <value>'?: string\n\n /**\n * User that initiated the deployment. Will be saved and displayed in the Shopify admin\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_USER\n */\n '--metadata-user <value>'?: string\n\n /**\n * Skip the routability verification step after deployment.\n *\n */\n '--no-verify'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Deploys to the Preview environment.\n *\n */\n '--preview'?: ''\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop <value>'?: string\n\n /**\n * Oxygen deployment token. Defaults to the linked storefront's token if available.\n * @environment SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\n */\n '-t, --token <value>'?: string\n}"
3286+
"value": "export interface hydrogendeploy {\n /**\n * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.\n * @environment AUTH_BYPASS_TOKEN\n */\n '--auth-bypass-token'?: ''\n\n /**\n * Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`\n * @environment AUTH_BYPASS_TOKEN_DURATION\n */\n '--auth-bypass-token-duration <value>'?: string\n\n /**\n * Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.\n *\n */\n '--build-command <value>'?: string\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch <value>'?: string\n\n /**\n * Path to an environment file to override existing environment variables for the deployment.\n *\n */\n '--env-file <value>'?: string\n\n /**\n * Forces a deployment to proceed if there are uncommited changes in its Git repository.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n */\n '--force-client-sourcemap'?: ''\n\n /**\n * Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.\n *\n */\n '--json-output'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION\n */\n '--metadata-description <value>'?: string\n\n /**\n * User that initiated the deployment. Will be saved and displayed in the Shopify admin\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_USER\n */\n '--metadata-user <value>'?: string\n\n /**\n * Skip the routability verification step after deployment.\n *\n */\n '--no-verify'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Deploys to the Preview environment.\n *\n */\n '--preview'?: ''\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop <value>'?: string\n\n /**\n * Oxygen deployment token. Defaults to the linked storefront's token if available.\n * @environment SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\n */\n '-t, --token <value>'?: string\n}"
32783287
}
32793288
}
32803289
}
@@ -3327,6 +3336,15 @@
33273336
"description": "Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.",
33283337
"isOptional": true
33293338
},
3339+
{
3340+
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
3341+
"syntaxKind": "PropertySignature",
3342+
"name": "--customer-account-push",
3343+
"value": "\"\"",
3344+
"description": "Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow",
3345+
"isOptional": true,
3346+
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH"
3347+
},
33303348
{
33313349
"filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
33323350
"syntaxKind": "PropertySignature",
@@ -3441,7 +3459,7 @@
34413459
"environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE"
34423460
}
34433461
],
3444-
"value": "export interface hydrogendev {\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path <value>'?: string\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER\n */\n '--disable-deps-optimizer'?: ''\n\n /**\n * Skip the version check when running `hydrogen dev`\n *\n */\n '--disable-version-check'?: ''\n\n /**\n * Disable rendering fallback routes when a route file doesn't exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES\n */\n '--disable-virtual-routes'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch <value>'?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file <value>'?: string\n\n /**\n * Expose the server to the local network\n *\n */\n '--host'?: ''\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port <value>'?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port <value>'?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
3462+
"value": "export interface hydrogendev {\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path <value>'?: string\n\n /**\n * Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow\n * @environment SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH\n */\n '--customer-account-push'?: ''\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER\n */\n '--disable-deps-optimizer'?: ''\n\n /**\n * Skip the version check when running `hydrogen dev`\n *\n */\n '--disable-version-check'?: ''\n\n /**\n * Disable rendering fallback routes when a route file doesn't exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES\n */\n '--disable-virtual-routes'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env <value>'?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch <value>'?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file <value>'?: string\n\n /**\n * Expose the server to the local network\n *\n */\n '--host'?: ''\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port <value>'?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port <value>'?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
34453463
}
34463464
}
34473465
}

packages/cli/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -999,9 +999,9 @@ Builds and deploys a Hydrogen storefront to Oxygen.
999999
```
10001000
USAGE
10011001
$ shopify hydrogen deploy [--auth-bypass-token-duration <value> --auth-bypass-token] [--build-command <value>]
1002-
[--entry <value>] [--env <value> | --env-branch <value>] [--env-file <value>] [-f] [--json-output]
1003-
[--lockfile-check] [--metadata-description <value>] [--metadata-user <value>] [--no-verify] [--path <value>]
1004-
[--preview] [-s <value>] [-t <value>]
1002+
[--entry <value>] [--env <value> | --env-branch <value>] [--env-file <value>] [-f] [--force-client-sourcemap]
1003+
[--json-output] [--lockfile-check] [--metadata-description <value>] [--metadata-user <value>] [--no-verify] [--path
1004+
<value>] [--preview] [-s <value>] [-t <value>]
10051005
10061006
FLAGS
10071007
-f, --force Forces a deployment to proceed if there are uncommited changes in its Git
@@ -1024,6 +1024,8 @@ FLAGS
10241024
name.
10251025
--env-file=<value> Path to an environment file to override existing environment variables for
10261026
the deployment.
1027+
--force-client-sourcemap Client sourcemapping is avoided by default because it makes backend code
1028+
visible in the browser. Use this flag to force enabling it.
10271029
--[no-]json-output Create a JSON file containing the deployment details in CI environments.
10281030
Defaults to true, use `--no-json-output` to disable.
10291031
--[no-]lockfile-check Checks that there is exactly one valid lockfile in the project. Defaults to
@@ -1047,14 +1049,17 @@ Runs Hydrogen storefront in an Oxygen worker for development.
10471049

10481050
```
10491051
USAGE
1050-
$ shopify hydrogen dev [--codegen-config-path <value> --codegen] [--debug] [--disable-deps-optimizer]
1051-
[--disable-version-check] [--disable-virtual-routes] [--entry <value>] [--env <value> | --env-branch <value>]
1052-
[--env-file <value>] [--host] [--inspector-port <value>] [--path <value>] [--port <value>] [--verbose]
1052+
$ shopify hydrogen dev [--codegen-config-path <value> --codegen] [--customer-account-push] [--debug]
1053+
[--disable-deps-optimizer] [--disable-version-check] [--disable-virtual-routes] [--entry <value>] [--env <value> |
1054+
--env-branch <value>] [--env-file <value>] [--host] [--inspector-port <value>] [--path <value>] [--port <value>]
1055+
[--verbose]
10531056
10541057
FLAGS
10551058
--codegen Automatically generates GraphQL types for your project’s Storefront API queries.
10561059
--codegen-config-path=<value> Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if
10571060
this file exists.
1061+
--customer-account-push Use tunneling for local development and push the tunneling domain to admin. Required to
1062+
use Customer Account API's OAuth flow
10581063
--debug Enables inspector connections to the server with a debugger such as Visual Studio Code
10591064
or Chrome DevTools.
10601065
--disable-deps-optimizer Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically

0 commit comments

Comments
 (0)