diff --git a/bin/docs/build-dev-docs.sh b/bin/docs/build-dev-docs.sh index 98eedfed6fb..53946b4c9ba 100644 --- a/bin/docs/build-dev-docs.sh +++ b/bin/docs/build-dev-docs.sh @@ -1,12 +1,12 @@ echo "STARTING" -COMPILE_DOCS="pnpx tsc --project bin/docs/tsconfig.docs.json --moduleResolution node --target esNext && pnpx generate-docs --overridePath ./bin/docs/typeOverride.json --input ./docs-shopify.dev/commands --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/commands/**/*.doc.js docs-shopify.dev/commands/*.doc.js" -COMPILE_STATIC_PAGES="pnpx tsc docs-shopify.dev/static/*.doc.ts --moduleResolution node --target esNext && pnpx generate-docs --isLandingPage --input ./docs-shopify.dev/static --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/static/*.doc.js" -COMPILE_CATEGORY_PAGES="pnpx tsc docs-shopify.dev/categories/*.doc.ts --moduleResolution node --target esNext && pnpx generate-docs --isCategoryPage --input ./docs-shopify.dev/categories --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/categories/*.doc.js" +COMPILE_DOCS="pnpm tsc --project bin/docs/tsconfig.docs.json --moduleResolution node --target esNext && pnpm generate-docs --overridePath ./bin/docs/typeOverride.json --input ./docs-shopify.dev/commands --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/commands/**/*.doc.js docs-shopify.dev/commands/*.doc.js" +COMPILE_STATIC_PAGES="pnpm tsc docs-shopify.dev/static/*.doc.ts --moduleResolution node --target esNext && pnpm generate-docs --isLandingPage --input ./docs-shopify.dev/static --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/static/*.doc.js" +COMPILE_CATEGORY_PAGES="pnpm tsc docs-shopify.dev/categories/*.doc.ts --moduleResolution node --target esNext && pnpm generate-docs --isCategoryPage --input ./docs-shopify.dev/categories --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/categories/*.doc.js" if [ "$1" = "isTest" ]; then -COMPILE_DOCS="pnpx tsc --project bin/docs/tsconfig.docs.json --moduleResolution node --target esNext && pnpx generate-docs --overridePath ./bin/docs/typeOverride.json --input ./docs-shopify.dev/commands --output ./docs-shopify.dev/static/temp && rm -rf docs-shopify.dev/commands/**/*.doc.js docs-shopify.dev/commands/*.doc.js" -COMPILE_STATIC_PAGES="pnpx tsc docs-shopify.dev/static/*.doc.ts --moduleResolution node --target esNext && pnpx generate-docs --isLandingPage --input ./docs-shopify.dev/static/docs-shopify.dev --output ./docs-shopify.dev/static/temp && rm -rf docs-shopify.dev/static/*.doc.js" +COMPILE_DOCS="pnpm tsc --project bin/docs/tsconfig.docs.json --moduleResolution node --target esNext && pnpm generate-docs --overridePath ./bin/docs/typeOverride.json --input ./docs-shopify.dev/commands --output ./docs-shopify.dev/static/temp && rm -rf docs-shopify.dev/commands/**/*.doc.js docs-shopify.dev/commands/*.doc.js" +COMPILE_STATIC_PAGES="pnpm tsc docs-shopify.dev/static/*.doc.ts --moduleResolution node --target esNext && pnpm generate-docs --isLandingPage --input ./docs-shopify.dev/static/docs-shopify.dev --output ./docs-shopify.dev/static/temp && rm -rf docs-shopify.dev/static/*.doc.js" fi echo $1 diff --git a/docs-shopify.dev/commands/config-autoupgrade-off.doc.ts b/docs-shopify.dev/commands/config-autoupgrade-off.doc.ts new file mode 100644 index 00000000000..75b62ff3224 --- /dev/null +++ b/docs-shopify.dev/commands/config-autoupgrade-off.doc.ts @@ -0,0 +1,34 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'config autoupgrade off', + description: `Disable automatic upgrades for Shopify CLI. + + When auto-upgrade is disabled, Shopify CLI won't automatically update. Run \`shopify upgrade\` to update manually. + + To enable auto-upgrade, run \`shopify config autoupgrade on\`. +`, + overviewPreviewDescription: `Disable automatic upgrades for Shopify CLI.`, + type: 'command', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'config autoupgrade off', + code: './examples/config-autoupgrade-off.example.sh', + language: 'bash', + }, + ], + title: 'config autoupgrade off', + }, + }, + definitions: [ + ], + category: 'general commands', + related: [ + ], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/commands/config-autoupgrade-on.doc.ts b/docs-shopify.dev/commands/config-autoupgrade-on.doc.ts new file mode 100644 index 00000000000..acc5bb39026 --- /dev/null +++ b/docs-shopify.dev/commands/config-autoupgrade-on.doc.ts @@ -0,0 +1,34 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'config autoupgrade on', + description: `Enable automatic upgrades for Shopify CLI. + + When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually. + + To disable auto-upgrade, run \`shopify config autoupgrade off\`. +`, + overviewPreviewDescription: `Enable automatic upgrades for Shopify CLI.`, + type: 'command', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'config autoupgrade on', + code: './examples/config-autoupgrade-on.example.sh', + language: 'bash', + }, + ], + title: 'config autoupgrade on', + }, + }, + definitions: [ + ], + category: 'general commands', + related: [ + ], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/commands/config-autoupgrade-status.doc.ts b/docs-shopify.dev/commands/config-autoupgrade-status.doc.ts new file mode 100644 index 00000000000..fce1d30aac7 --- /dev/null +++ b/docs-shopify.dev/commands/config-autoupgrade-status.doc.ts @@ -0,0 +1,34 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'config autoupgrade status', + description: `Check whether auto-upgrade is enabled, disabled, or not yet configured. + + When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command. + + Run \`shopify config autoupgrade on\` or \`shopify config autoupgrade off\` to configure it. +`, + overviewPreviewDescription: `Check whether auto-upgrade is enabled, disabled, or not yet configured.`, + type: 'command', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'config autoupgrade status', + code: './examples/config-autoupgrade-status.example.sh', + language: 'bash', + }, + ], + title: 'config autoupgrade status', + }, + }, + definitions: [ + ], + category: 'general commands', + related: [ + ], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/commands/examples/config-autoupgrade-off.example.sh b/docs-shopify.dev/commands/examples/config-autoupgrade-off.example.sh new file mode 100644 index 00000000000..e6b28d09bd1 --- /dev/null +++ b/docs-shopify.dev/commands/examples/config-autoupgrade-off.example.sh @@ -0,0 +1 @@ +shopify config autoupgrade off \ No newline at end of file diff --git a/docs-shopify.dev/commands/examples/config-autoupgrade-on.example.sh b/docs-shopify.dev/commands/examples/config-autoupgrade-on.example.sh new file mode 100644 index 00000000000..71f0109cbb5 --- /dev/null +++ b/docs-shopify.dev/commands/examples/config-autoupgrade-on.example.sh @@ -0,0 +1 @@ +shopify config autoupgrade on \ No newline at end of file diff --git a/docs-shopify.dev/commands/examples/config-autoupgrade-status.example.sh b/docs-shopify.dev/commands/examples/config-autoupgrade-status.example.sh new file mode 100644 index 00000000000..5c94f013999 --- /dev/null +++ b/docs-shopify.dev/commands/examples/config-autoupgrade-status.example.sh @@ -0,0 +1 @@ +shopify config autoupgrade status \ No newline at end of file diff --git a/docs-shopify.dev/commands/interfaces/config-autoupgrade-off.interface.ts b/docs-shopify.dev/commands/interfaces/config-autoupgrade-off.interface.ts new file mode 100644 index 00000000000..515307131ea --- /dev/null +++ b/docs-shopify.dev/commands/interfaces/config-autoupgrade-off.interface.ts @@ -0,0 +1,8 @@ +// This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `config autoupgrade off` command: + * @publicDocs + */ +export interface configautoupgradeoff { + +} diff --git a/docs-shopify.dev/commands/interfaces/config-autoupgrade-on.interface.ts b/docs-shopify.dev/commands/interfaces/config-autoupgrade-on.interface.ts new file mode 100644 index 00000000000..9b2d007ecf3 --- /dev/null +++ b/docs-shopify.dev/commands/interfaces/config-autoupgrade-on.interface.ts @@ -0,0 +1,8 @@ +// This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `config autoupgrade on` command: + * @publicDocs + */ +export interface configautoupgradeon { + +} diff --git a/docs-shopify.dev/commands/interfaces/config-autoupgrade-status.interface.ts b/docs-shopify.dev/commands/interfaces/config-autoupgrade-status.interface.ts new file mode 100644 index 00000000000..c6d74fb288b --- /dev/null +++ b/docs-shopify.dev/commands/interfaces/config-autoupgrade-status.interface.ts @@ -0,0 +1,8 @@ +// This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `config autoupgrade status` command: + * @publicDocs + */ +export interface configautoupgradestatus { + +} diff --git a/docs-shopify.dev/generated/generated_docs_data.json b/docs-shopify.dev/generated/generated_docs_data.json index 847227501ff..87ab61300cf 100644 --- a/docs-shopify.dev/generated/generated_docs_data.json +++ b/docs-shopify.dev/generated/generated_docs_data.json @@ -3692,6 +3692,72 @@ "category": "general commands", "related": [] }, + { + "name": "config autoupgrade off", + "description": "Disable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is disabled, Shopify CLI won't automatically update. Run `shopify upgrade` to update manually.\n\n To enable auto-upgrade, run `shopify config autoupgrade on`.\n", + "overviewPreviewDescription": "Disable automatic upgrades for Shopify CLI.", + "type": "command", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "config autoupgrade off", + "code": "shopify config autoupgrade off", + "language": "bash" + } + ], + "title": "config autoupgrade off" + } + }, + "definitions": [], + "category": "general commands", + "related": [] + }, + { + "name": "config autoupgrade on", + "description": "Enable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually.\n\n To disable auto-upgrade, run `shopify config autoupgrade off`.\n", + "overviewPreviewDescription": "Enable automatic upgrades for Shopify CLI.", + "type": "command", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "config autoupgrade on", + "code": "shopify config autoupgrade on", + "language": "bash" + } + ], + "title": "config autoupgrade on" + } + }, + "definitions": [], + "category": "general commands", + "related": [] + }, + { + "name": "config autoupgrade status", + "description": "Check whether auto-upgrade is enabled, disabled, or not yet configured.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command.\n\n Run `shopify config autoupgrade on` or `shopify config autoupgrade off` to configure it.\n", + "overviewPreviewDescription": "Check whether auto-upgrade is enabled, disabled, or not yet configured.", + "type": "command", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "config autoupgrade status", + "code": "shopify config autoupgrade status", + "language": "bash" + } + ], + "title": "config autoupgrade status" + } + }, + "definitions": [], + "category": "general commands", + "related": [] + }, { "name": "help", "description": "Display help for Shopify CLI", diff --git a/docs-shopify.dev/generated/generated_docs_data_v2.json b/docs-shopify.dev/generated/generated_docs_data_v2.json index 71326e7eca9..6283b908b29 100644 --- a/docs-shopify.dev/generated/generated_docs_data_v2.json +++ b/docs-shopify.dev/generated/generated_docs_data_v2.json @@ -2757,6 +2757,36 @@ "value": "export interface configautocorrectstatus {\n\n}" } }, + "configautoupgradeoff": { + "docs-shopify.dev/commands/interfaces/config-autoupgrade-off.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/config-autoupgrade-off.interface.ts", + "name": "configautoupgradeoff", + "description": "The following flags are available for the `config autoupgrade off` command:", + "isPublicDocs": true, + "members": [], + "value": "export interface configautoupgradeoff {\n\n}" + } + }, + "configautoupgradeon": { + "docs-shopify.dev/commands/interfaces/config-autoupgrade-on.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/config-autoupgrade-on.interface.ts", + "name": "configautoupgradeon", + "description": "The following flags are available for the `config autoupgrade on` command:", + "isPublicDocs": true, + "members": [], + "value": "export interface configautoupgradeon {\n\n}" + } + }, + "configautoupgradestatus": { + "docs-shopify.dev/commands/interfaces/config-autoupgrade-status.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/config-autoupgrade-status.interface.ts", + "name": "configautoupgradestatus", + "description": "The following flags are available for the `config autoupgrade status` command:", + "isPublicDocs": true, + "members": [], + "value": "export interface configautoupgradestatus {\n\n}" + } + }, "help": { "docs-shopify.dev/commands/interfaces/help.interface.ts": { "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts",