Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

magento/devdocs#: Cloud. Upgrade Magento to 2.3.5 #7135

Merged
merged 2 commits into from
May 4, 2020

Conversation

atwixfirster
Copy link
Contributor

@atwixfirster atwixfirster commented Apr 30, 2020

Purpose of this pull request

This pull request (PR) removes version-specific information from the command instruction to upgrade the Magento version for Cloud Projects via composer. This improvement means we won't have to update the instruction when each time a Magento version is releases.

Affected DevDocs pages

Links to Magento source code

Thank you!

@devops-devdocs
Copy link
Collaborator

An admin must run tests on this PR before it can be merged.

@@ -107,7 +107,7 @@ To upgrade the Magento version:
1. Change to your Magento root directory and set the upgrade version using the [version constraint syntax].

```bash
composer require "magento/magento-cloud-metapackage":">=2.x.2 <2.x.3" --no-update
composer require "magento/magento-cloud-metapackage":">=2.3.5 <2.3.6" --no-update
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need to specify the exact version here?
I guess it's rather an example of version constraint syntax, isn't it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My idea is: provide a actual example how to upgrade Cloud to the latest Magento version.

Let's ask @meker12 for help here.

@meker12, should we use in the example the latest Magento version or we should leave all as it is here?

Thank you!

Copy link
Contributor

@rogyar rogyar Apr 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@atwixfirster your example shows how to upgrade to the exact version, not to the latest one (in this particular case we may consider as latest one but the version constraint syntax is about the exact patch version).

If we are talking about Magento upgrade literally

When upgrading to 2.3.x from 2.2.x ...

then I assume we may use

composer require "magento/magento-cloud-metapackage":"2.3.*" --no-update

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The key point is that we should keep using the constraint approach in any case. This is the appropriate way to keep ece-tools up to date along with the patch versions automatically installed on Magento Cloud.

What I wanted to say is that the aforementioned document is not intended to show how to upgrade to the concrete Magento version. I think the initial goal was to highlight the general approaches to be used in order to upgrade Magento and provide some recommendations depending on a situation.

My idea is: provide a actual example how to upgrade Cloud to the latest Magento version.

@atwixfirster if you wish to apply this change, I guess the following page is the right place :)
https://devdocs.magento.com/cloud/project/ece-tools-upgrade-project.html#metapackage

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So @dmytro-ch Is correct that the intent of the documentation is to show an example. However, in this case the example is referencing a particular version. From a documentation maintenance perspective, we should present example that doesn't require update every release.

I like @rogyar suggestion, but according to the note below step 1, you need to use the version constraint syntax to successfully update the ece-tools package.

I have an idea--will make a suggestion.

Also as @dmytro-ch pointed out -- we have two instances to change:
https://devdocs.magento.com/cloud/project/project-upgrade.html
https://devdocs.magento.com/cloud/project/ece-tools-upgrade-project.html#metapackage

@rogyar rogyar added 2.3.x Magento 2.3 related changes Technical Updates to the code or processes that alter the technical content of the doc labels Apr 30, 2020
@meker12 meker12 self-requested a review April 30, 2020 17:32
@@ -107,7 +107,7 @@ To upgrade the Magento version:
1. Change to your Magento root directory and set the upgrade version using the [version constraint syntax].

```bash
composer require "magento/magento-cloud-metapackage":">=2.x.2 <2.x.3" --no-update
composer require "magento/magento-cloud-metapackage":">=2.3.5 <2.3.6" --no-update
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So @dmytro-ch Is correct that the intent of the documentation is to show an example. However, in this case the example is referencing a particular version. From a documentation maintenance perspective, we should present example that doesn't require update every release.

I like @rogyar suggestion, but according to the note below step 1, you need to use the version constraint syntax to successfully update the ece-tools package.

I have an idea--will make a suggestion.

Also as @dmytro-ch pointed out -- we have two instances to change:
https://devdocs.magento.com/cloud/project/project-upgrade.html
https://devdocs.magento.com/cloud/project/ece-tools-upgrade-project.html#metapackage

@@ -107,7 +107,7 @@ To upgrade the Magento version:
1. Change to your Magento root directory and set the upgrade version using the [version constraint syntax].

```bash
composer require "magento/magento-cloud-metapackage":">=2.x.2 <2.x.3" --no-update
composer require "magento/magento-cloud-metapackage":">=2.3.5 <2.3.6" --no-update
Copy link
Contributor

@meker12 meker12 Apr 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change the version number in the code sample to use placeholders for current and next version--same technique used in the Upgrade to ece-tools topic.

Suggested change
composer require "magento/magento-cloud-metapackage":">=2.3.5 <2.3.6" --no-update
composer require "magento/magento-cloud-metapackage":">=current_version <next_version" --no-update

On line 114, there is a note:

You must use the version constraint syntax to successfully update the `{{site.data.var.ct}}` package.

Update that note to add info about where they can find the most current version constraint:

You must use the version constraint syntax to successfully update the `{{site.data.var.ct}}` package. You can find the version constraint in the `composer.json` file for the version of the [Magento application template](https://github.com/magento/magento-cloud/blob/master/composer.json) you are using for the upgrade.

Copy link
Contributor Author

@atwixfirster atwixfirster May 2, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

implemented

Thank you, @meker12!

@atwixfirster atwixfirster force-pushed the cloud-upgrade-magento-2.3.5 branch from 0160a10 to 1f895d9 Compare May 2, 2020 15:24
Copy link
Contributor

@meker12 meker12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks for the contribution.

@meker12
Copy link
Contributor

meker12 commented May 4, 2020

running tests

@meker12 meker12 merged commit b69fab3 into magento:master May 4, 2020
@ghost
Copy link

ghost commented May 4, 2020

Hi @atwixfirster, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.3.x Magento 2.3 related changes Partner: Atwix partners-contribution PR created by Magento partner Technical Updates to the code or processes that alter the technical content of the doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants