From 76682699f7b10e436481b36f62ffa7e6d6e7290a Mon Sep 17 00:00:00 2001 From: Margaret Eker Date: Tue, 14 May 2019 10:43:39 -0400 Subject: [PATCH 1/3] Add FORCE_UPDATE_URLS deploy variable doc --- guides/v2.1/cloud/env/variables-deploy.md | 18 ++++++++++++++++-- guides/v2.1/cloud/release-notes/cloud-tools.md | 3 +++ guides/v2.2/cloud/env/variables-deploy.md | 17 +++++++++++++++-- guides/v2.2/cloud/release-notes/cloud-tools.md | 2 ++ guides/v2.3/cloud/release-notes/cloud-tools.md | 4 ++++ 5 files changed, 40 insertions(+), 4 deletions(-) diff --git a/guides/v2.1/cloud/env/variables-deploy.md b/guides/v2.1/cloud/env/variables-deploy.md index a6dae8625d8..bc14111005c 100644 --- a/guides/v2.1/cloud/env/variables-deploy.md +++ b/guides/v2.1/cloud/env/variables-deploy.md @@ -424,7 +424,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 the project URLs specified in the `MAGENTO_CLOUD_ROUTES` 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. + +To update URLs when deploying to staging or production environments, use the `FORCE_UPDATE_URLS` variable. ```yaml stage: @@ -432,7 +435,18 @@ 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. +### `FORCE_UPDATE_URLS` + +- **Default**—`true` +- **Version**—Magento 2.1.4 and later + +On deployment to staging and production environments, this variable replaces Magento base URLs in the database with the project URLs specified in the `MAGENTO_CLOUD_ROUTES` variable. Use this setting to override the default behavior of the UPDATE_URLS variable which is ignored when deploying to staging or production environments. + +```yaml +stage: + deploy: + FORCE_UPDATE_URLS: true +``` ### `VERBOSE_COMMANDS` diff --git a/guides/v2.1/cloud/release-notes/cloud-tools.md b/guides/v2.1/cloud/release-notes/cloud-tools.md index 947f15608f0..ca8c7cbd1bb 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 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..5d55164a606 100644 --- a/guides/v2.2/cloud/env/variables-deploy.md +++ b/guides/v2.2/cloud/env/variables-deploy.md @@ -512,7 +512,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` 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. + +To update URLs when deploying to staging or production environments, use the `FORCE_UPDATE_URLS` variable. ```yaml stage: @@ -520,7 +522,18 @@ 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. +### `FORCE_UPDATE_URLS` + +- **Default**—`true` +- **Version**—Magento 2.1.4 and later + +On deployment to staging and production environments, this variable replaces Magento base URLs in the database with the project URLs specified by the `MAGENTO_CLOUD_ROUTES` variable. Use this setting to override the default behavior of the UPDATE_URLS variable which is ignored when deploying to staging or production environments. + +```yaml +stage: + deploy: + FORCE_UPDATE_URLS: true +``` ### `VERBOSE_COMMANDS` diff --git a/guides/v2.2/cloud/release-notes/cloud-tools.md b/guides/v2.2/cloud/release-notes/cloud-tools.md index 5553abfc88c..89eb0a816ff 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 the following environments: Pro Production and Staging, Starter Production (`master` branch) and Staging. This setting overrides the default behavior of the `UPDATE_URLS` variable which is ignored when deploying to 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..3b179888291 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 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 From 6d665448d430bd063e850c5c1985487c0fada635 Mon Sep 17 00:00:00 2001 From: Margaret Eker Date: Tue, 14 May 2019 13:23:49 -0400 Subject: [PATCH 2/3] Updates based on review feedback --- guides/v2.1/cloud/env/variables-deploy.md | 30 +++++++++---------- .../v2.1/cloud/release-notes/cloud-tools.md | 2 +- guides/v2.2/cloud/env/variables-deploy.md | 30 +++++++++---------- .../v2.2/cloud/release-notes/cloud-tools.md | 2 +- .../v2.3/cloud/release-notes/cloud-tools.md | 2 +- 5 files changed, 33 insertions(+), 33 deletions(-) diff --git a/guides/v2.1/cloud/env/variables-deploy.md b/guides/v2.1/cloud/env/variables-deploy.md index bc14111005c..803b76025d2 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 in 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,10 +437,10 @@ stage: - **Default**—`true` - **Version**—Magento 2.1.4 and later -On deployment, replace Magento base URLs in the database the project URLs specified in the `MAGENTO_CLOUD_ROUTES` variable. This is useful for local development, where base URLs are set up for your local environment. +On deployment, replace Magento base URLs in the database with the project URLs specified in 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. -To update URLs when deploying to staging or production environments, use the `FORCE_UPDATE_URLS` variable. +If you need to update URLs when deploying to staging or production environments, use the [`FORCE_UPDATE_URLS`](#force_update_urls) variable. ```yaml stage: @@ -435,19 +448,6 @@ stage: UPDATE_URLS: false ``` -### `FORCE_UPDATE_URLS` - -- **Default**—`true` -- **Version**—Magento 2.1.4 and later - -On deployment to staging and production environments, this variable replaces Magento base URLs in the database with the project URLs specified in the `MAGENTO_CLOUD_ROUTES` variable. Use this setting to override the default behavior of the UPDATE_URLS variable which is ignored when deploying to staging or production environments. - -```yaml -stage: - deploy: - FORCE_UPDATE_URLS: true -``` - ### `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 ca8c7cbd1bb..77d91585161 100644 --- a/guides/v2.1/cloud/release-notes/cloud-tools.md +++ b/guides/v2.1/cloud/release-notes/cloud-tools.md @@ -34,7 +34,7 @@ The release notes include: - {:.new}**Environment variable updates**— - - {:.new}Added the **FORCE_UPDATE_URLS** deploy variable to update Magento base URLs when deploying to production and staging environments. See the definition in the [deploy variables]({{ page.baseurl }}/cloud/env/variables-deploy.html#force_update_urls) content. + - {:.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 5d55164a606..5a64787d151 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,9 +525,9 @@ stage: - **Default**—`true` - **Version**—Magento 2.1.4 and later -On deployment, replace Magento base URLs in the database with the project URLs specified by the `MAGENTO_CLOUD_ROUTES` 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. +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. -To update URLs when deploying to staging or production environments, use the `FORCE_UPDATE_URLS` variable. +If you need to update URLs when deploying to Pro and Starter staging or production environments, use the [`FORCE_UPDATE_URLS`](#force_update_urls) variable. ```yaml stage: @@ -522,19 +535,6 @@ stage: UPDATE_URLS: false ``` -### `FORCE_UPDATE_URLS` - -- **Default**—`true` -- **Version**—Magento 2.1.4 and later - -On deployment to staging and production environments, this variable replaces Magento base URLs in the database with the project URLs specified by the `MAGENTO_CLOUD_ROUTES` variable. Use this setting to override the default behavior of the UPDATE_URLS variable which is ignored when deploying to staging or production environments. - -```yaml -stage: - deploy: - FORCE_UPDATE_URLS: true -``` - ### `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 89eb0a816ff..ff418313e36 100644 --- a/guides/v2.2/cloud/release-notes/cloud-tools.md +++ b/guides/v2.2/cloud/release-notes/cloud-tools.md @@ -34,7 +34,7 @@ The release notes include: - {:.new}**Environment variable updates**— - - {:.new}Added the **FORCE_UPDATE_URLS** deploy variable to update Magento base URLs when deploying to the following environments: Pro Production and Staging, Starter Production (`master` branch) and Staging. This setting overrides the default behavior of the `UPDATE_URLS` variable which is ignored when deploying to production and staging environments. See the definition in the [deploy variables]({{ page.baseurl }}/cloud/env/variables-deploy.html#force_update_urls) content. + - {:.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 3b179888291..89122cadae1 100644 --- a/guides/v2.3/cloud/release-notes/cloud-tools.md +++ b/guides/v2.3/cloud/release-notes/cloud-tools.md @@ -34,7 +34,7 @@ The release notes include: - {:.new}**Environment variable updates**— - - {:.new}Added the **FORCE_UPDATE_URLS** deploy variable to update Magento base URLs when deploying to production and staging environments. See the definition in the [deploy variables]({{ page.baseurl }}/cloud/env/variables-deploy.html#force_update_urls) content. + - {:.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 From b5a83087fa28bf892bcd29358cb6fd9098a8cf66 Mon Sep 17 00:00:00 2001 From: Margaret Eker Date: Tue, 14 May 2019 13:38:23 -0400 Subject: [PATCH 3/3] Apply suggestions from code review --- guides/v2.1/cloud/env/variables-deploy.md | 6 +++--- guides/v2.2/cloud/env/variables-deploy.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/guides/v2.1/cloud/env/variables-deploy.md b/guides/v2.1/cloud/env/variables-deploy.md index 803b76025d2..f31c2875803 100644 --- a/guides/v2.1/cloud/env/variables-deploy.md +++ b/guides/v2.1/cloud/env/variables-deploy.md @@ -129,7 +129,7 @@ The {{ site.data.var.ece }} deploy process always enables Google Analytics on Pr - **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 in 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. +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: @@ -437,10 +437,10 @@ stage: - **Default**—`true` - **Version**—Magento 2.1.4 and later -On deployment, replace Magento base URLs in the database with the project URLs specified in 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. +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 staging or production environments, use the [`FORCE_UPDATE_URLS`](#force_update_urls) variable. +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: diff --git a/guides/v2.2/cloud/env/variables-deploy.md b/guides/v2.2/cloud/env/variables-deploy.md index 5a64787d151..8c9f7f25d2c 100644 --- a/guides/v2.2/cloud/env/variables-deploy.md +++ b/guides/v2.2/cloud/env/variables-deploy.md @@ -527,7 +527,7 @@ stage: 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 and Starter staging or production environments, use the [`FORCE_UPDATE_URLS`](#force_update_urls) variable. +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: