This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Add FORCE_UPDATE_URLS deploy variable doc #4516
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hguthrie
suggested changes
May 14, 2019
|
|
||
| ```yaml | ||
| stage: | ||
| deploy: | ||
| 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` |
There was a problem hiding this comment.
All of these variables are in alphabetical order.
There was a problem hiding this comment.
So I know that -- I thought this one is so closely related to the UPDATE_URLS one that it made sense to put them together. It's a trade off. I can move to the correct alphabetical location if you think that's more important than proximity to related variable.
There was a problem hiding this comment.
in reference material, proximity is not something I consider. I don't think that I would go to the U if I were looking for F. Although, my instinct is CMD+F in this case, the right navigation grabs the alphabetic attention. so that would be the anomaly.
| @@ -424,15 +424,29 @@ 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. | |||
There was a problem hiding this comment.
Maybe provide a link to the variable definition.
| 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. |
There was a problem hiding this comment.
Suggested change
| 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 the Staging or Production environments, use the [`FORCE_UPDATE_URLS` variable](#force_update_urls). |
| 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. |
There was a problem hiding this comment.
Suggested change
| 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 the Staging or Production environments, use the [`FORCE_UPDATE_URLS` variable](#force_update_urls). |
oshmyheliuk
reviewed
May 14, 2019
| @@ -424,15 +424,29 @@ 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. | |||
There was a problem hiding this comment.
replace Magento base URLs in the database the project URLs specified in the
I'm not sure but maybe with is missed.
replace Magento base URLs in the database with the project URLs specified in the
meker12
commented
May 14, 2019
meker12
commented
May 14, 2019
meker12
commented
May 14, 2019
meker12
commented
May 14, 2019
hguthrie
approved these changes
May 14, 2019
meker12
commented
May 14, 2019
| - **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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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) variable which is ignored when deploying to staging and production environments. |
|
Hi @meker12, thank you for your contribution! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
Added documentation for the FORCE_UPDATE_URLS deploy variable to update URLs when deploying Magento Commerce Cloud projects to staging and production environments.
Affected DevDocs pages
Links to Magento source code
https://github.com/magento/ece-tools/blob/develop/dist/.magento.env.yaml#L189
whatsnew
Added the FORCE_UPDATE_URLS deploy variable to update Magento base URLs when deploying Magento Commerce Cloud projects to production and staging environments.