Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions bin/docs/build-dev-docs.sh
Original file line number Diff line number Diff line change
@@ -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
Expand Down
34 changes: 34 additions & 0 deletions docs-shopify.dev/commands/config-autoupgrade-off.doc.ts
Original file line number Diff line number Diff line change
@@ -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
34 changes: 34 additions & 0 deletions docs-shopify.dev/commands/config-autoupgrade-on.doc.ts
Original file line number Diff line number Diff line change
@@ -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
34 changes: 34 additions & 0 deletions docs-shopify.dev/commands/config-autoupgrade-status.doc.ts
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shopify config autoupgrade off
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shopify config autoupgrade on
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shopify config autoupgrade status
Original file line number Diff line number Diff line change
@@ -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 {

}
Original file line number Diff line number Diff line change
@@ -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 {

}
Original file line number Diff line number Diff line change
@@ -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 {

}
66 changes: 66 additions & 0 deletions docs-shopify.dev/generated/generated_docs_data.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
30 changes: 30 additions & 0 deletions docs-shopify.dev/generated/generated_docs_data_v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading