diff --git a/guides/v2.1/cloud/env/variables-deploy.md b/guides/v2.1/cloud/env/variables-deploy.md index a6dae8625d8..f31c2875803 100644 --- a/guides/v2.1/cloud/env/variables-deploy.md +++ b/guides/v2.1/cloud/env/variables-deploy.md @@ -124,6 +124,19 @@ stage: {:.bs-callout .bs-callout-info} The {{ site.data.var.ece }} deploy process always enables Google Analytics on Production environments. +### `FORCE_UPDATE_URLS` + +- **Default**—`true` +- **Version**—Magento 2.1.4 and later + +On deployment to Pro and Starter staging and production environments, this variable replaces Magento base URLs in the database with the project URLs specified by the [`MAGENTO_CLOUD_ROUTES`]({{ page.baseurl}}/cloud/env/variables-cloud.html) variable. Use this setting to override the default behavior of the [UPDATE_URLS](#update_urls) variable which is ignored when deploying to staging and production environments. + +```yaml +stage: + deploy: + FORCE_UPDATE_URLS: true +``` + ### `GENERATED_CODE_SYMLINK` - **Default**—`true` @@ -424,7 +437,10 @@ stage: - **Default**—`true` - **Version**—Magento 2.1.4 and later -On deployment, replace Magento base URLs in the database with project URLs. This is useful for local development, where base URLs are set up for your local environment. When you deploy to a Cloud environment, we change the URLs so you can access your storefront and Magento Admin using project URLs. +On deployment, replace Magento base URLs in the database with the project URLs specified by the [`MAGENTO_CLOUD_ROUTES`]({{ page.baseurl }}/cloud/env/variables-cloud.html) variable. This is useful for local development, where base URLs are set up for your local environment. +When you deploy to a Cloud environment, we change the URLs so you can access your storefront and Magento Admin using project URLs. + +If you need to update URLs when deploying to Pro or Starter staging and production environments, use the [`FORCE_UPDATE_URLS`](#force_update_urls) variable. ```yaml stage: @@ -432,8 +448,6 @@ stage: UPDATE_URLS: false ``` -You should set this variable to `false` _only_ in Staging or Production environments, where the base URLs cannot change. For Pro, we already set this to `false` for you. - ### `VERBOSE_COMMANDS` - **Default**—_Not set_ diff --git a/guides/v2.1/cloud/release-notes/cloud-tools.md b/guides/v2.1/cloud/release-notes/cloud-tools.md index 947f15608f0..77d91585161 100644 --- a/guides/v2.1/cloud/release-notes/cloud-tools.md +++ b/guides/v2.1/cloud/release-notes/cloud-tools.md @@ -32,6 +32,9 @@ The release notes include: ## v2002.0.19 +- {:.new}**Environment variable updates**— + + - {:.new}Added the **FORCE_UPDATE_URLS** deploy variable to update Magento base URLs when deploying to Pro and Starter production and staging environments. See the definition in the [deploy variables]({{ page.baseurl }}/cloud/env/variables-deploy.html#force_update_urls) content. ## v2002.0.18 diff --git a/guides/v2.2/cloud/env/variables-deploy.md b/guides/v2.2/cloud/env/variables-deploy.md index e67c680214c..8c9f7f25d2c 100644 --- a/guides/v2.2/cloud/env/variables-deploy.md +++ b/guides/v2.2/cloud/env/variables-deploy.md @@ -194,6 +194,19 @@ stage: {:.bs-callout .bs-callout-info} The {{ site.data.var.ece }} deploy process always enables Google Analytics on Production environments. +### `FORCE_UPDATE_URLS` + +- **Default**—`true` +- **Version**—Magento 2.1.4 and later + +On deployment to Pro or Starter staging and production environments, this variable replaces Magento base URLs in the database with the project URLs specified by the [`MAGENTO_CLOUD_ROUTES`]({{page.baseurl}}/cloud/env/variables-cloud.html) variable. Use this setting to override the default behavior of the [UPDATE_URLS](#update_urls) deploy variable which is ignored when deploying to staging or production environments. + +```yaml +stage: + deploy: + FORCE_UPDATE_URLS: true +``` + ### `MYSQL_USE_SLAVE_CONNECTION` - **Default**—`false` @@ -512,7 +525,9 @@ stage: - **Default**—`true` - **Version**—Magento 2.1.4 and later -On deployment, replace Magento base URLs in the database with project URLs. This is useful for local development, where base URLs are set up for your local environment. When you deploy to a Cloud environment, we change the URLs so you can access your storefront and Magento Admin using project URLs. +On deployment, replace Magento base URLs in the database with the project URLs specified by the [`MAGENTO_CLOUD_ROUTES`]({{page.baseurl}}/cloud/env/variables-cloud.html) variable. This is useful for local development, where base URLs are set up for your local environment. When you deploy to a Cloud environment, we change the URLs so you can access your storefront and Magento Admin using project URLs. + +If you need to update URLs when deploying to Pro or Starter staging and production environments, use the [`FORCE_UPDATE_URLS`](#force_update_urls) variable. ```yaml stage: @@ -520,8 +535,6 @@ stage: UPDATE_URLS: false ``` -You should set this variable to `false` _only_ in Staging or Production environments, where the base URLs cannot change. For Pro, we already set this to `false` for you. - ### `VERBOSE_COMMANDS` - **Default**—_Not set_ diff --git a/guides/v2.2/cloud/release-notes/cloud-tools.md b/guides/v2.2/cloud/release-notes/cloud-tools.md index 5553abfc88c..ff418313e36 100644 --- a/guides/v2.2/cloud/release-notes/cloud-tools.md +++ b/guides/v2.2/cloud/release-notes/cloud-tools.md @@ -32,7 +32,9 @@ The release notes include: ## v2002.0.19 +- {:.new}**Environment variable updates**— + - {:.new}Added the **FORCE_UPDATE_URLS** deploy variable to update Magento base URLs when deploying to Pro and Starter production and staging environments. See the definition in the [deploy variables]({{ page.baseurl }}/cloud/env/variables-deploy.html#force_update_urls) content. ## v2002.0.18 diff --git a/guides/v2.3/cloud/release-notes/cloud-tools.md b/guides/v2.3/cloud/release-notes/cloud-tools.md index de7af58fb06..89122cadae1 100644 --- a/guides/v2.3/cloud/release-notes/cloud-tools.md +++ b/guides/v2.3/cloud/release-notes/cloud-tools.md @@ -32,6 +32,10 @@ The release notes include: ## v2002.0.19 +- {:.new}**Environment variable updates**— + + - {:.new}Added the **FORCE_UPDATE_URLS** deploy variable to update Magento base URLs when deploying to Pro and Starter production and staging environments. See the definition in the [deploy variables]({{ page.baseurl }}/cloud/env/variables-deploy.html#force_update_urls) content. + ## v2002.0.18