From 33cb404c6a425b61c5760d1e8891110cdea14d11 Mon Sep 17 00:00:00 2001 From: upgrader Date: Mon, 24 Jul 2023 12:01:07 +0200 Subject: [PATCH 1/5] SDK-2466 update security releases docs --- docs/scu/dev/how-the-spryker-code-upgrader-works.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/scu/dev/how-the-spryker-code-upgrader-works.md b/docs/scu/dev/how-the-spryker-code-upgrader-works.md index b982b30e5f2..b0ed2cc7da4 100644 --- a/docs/scu/dev/how-the-spryker-code-upgrader-works.md +++ b/docs/scu/dev/how-the-spryker-code-upgrader-works.md @@ -25,11 +25,15 @@ As modules depend on other modules, we tend to release them in groups. When the ### 2. Updates the modules and libraries -Using `composer`, the Upgrader tool updates the modules in groups. After updating the modules, the Upgrader tool returns the list of updated modules and proceeds to the next step. +Using `composer`, the Upgrader tool updates the modules in groups. + +Firstly it applies the security releases (the releases with security updates). For such releases only minor and patch versions are applied. The major releases will be applied after the module be updated to major version. + +After updating the modules, the Upgrader tool returns the list of updated modules and proceeds to the next step. If the Upgrader tool can’t update a module, it skips the module and the remaining groups. If all the groups failed to update, the Upgrader tool returns the errors causing this and stops. With at least one group updated, it returns the list of updated modules and proceeds to the next step. -By default, the Upgrader tool updates only minor and patch versions. When the Upgrader tool finds a group with a [major release](/docs/scos/dev/architecture/module-api/semantic-versioning-major-vs.-minor-vs.-patch-release.html#what-is-a-major-release), it won't update it and informs you about that: +By default, the Upgrader tool updates only minor and patch versions. When the Upgrader tool finds a group with a [major release](/docs/scos/dev/architecture/module-api/semantic-versioning-major-vs.-minor-vs.-patch-release.html#what-is-a-major-release), it won't update it and informs you about that (the exclusion only for the security major releases that silently skipped): ```bash There is a major release available for module spryker/merchant-product-approval. From bb25750741a8a0d10691bbf85abafbdc883b603d Mon Sep 17 00:00:00 2001 From: upgrader Date: Mon, 24 Jul 2023 12:03:19 +0200 Subject: [PATCH 2/5] SDK-2466 typo fix --- docs/scu/dev/how-the-spryker-code-upgrader-works.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scu/dev/how-the-spryker-code-upgrader-works.md b/docs/scu/dev/how-the-spryker-code-upgrader-works.md index b0ed2cc7da4..d7b10a2379f 100644 --- a/docs/scu/dev/how-the-spryker-code-upgrader-works.md +++ b/docs/scu/dev/how-the-spryker-code-upgrader-works.md @@ -27,7 +27,7 @@ As modules depend on other modules, we tend to release them in groups. When the Using `composer`, the Upgrader tool updates the modules in groups. -Firstly it applies the security releases (the releases with security updates). For such releases only minor and patch versions are applied. The major releases will be applied after the module be updated to major version. +Firstly it applies the security releases (the releases with security updates). For such releases only minor and patch versions are applied. The major releases will be applied after the module be updated to the major version. After updating the modules, the Upgrader tool returns the list of updated modules and proceeds to the next step. From 572c7c100fe92fc85f28f45d47a8c8930f8201a0 Mon Sep 17 00:00:00 2001 From: Vadym Sachenko Date: Mon, 24 Jul 2023 16:45:54 +0300 Subject: [PATCH 3/5] Update how-the-spryker-code-upgrader-works.md --- docs/scu/dev/how-the-spryker-code-upgrader-works.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/scu/dev/how-the-spryker-code-upgrader-works.md b/docs/scu/dev/how-the-spryker-code-upgrader-works.md index d7b10a2379f..177892896e2 100644 --- a/docs/scu/dev/how-the-spryker-code-upgrader-works.md +++ b/docs/scu/dev/how-the-spryker-code-upgrader-works.md @@ -2,6 +2,7 @@ title: How the Spryker Code Upgrader works description: Spryker Code Upgrader overview template: concept-topic-template +last_updated: Jul 24, 2023 redirect_from: - /docs/paas-plus/dev/how-the-spryker-code-upgrader-works.html --- @@ -27,13 +28,13 @@ As modules depend on other modules, we tend to release them in groups. When the Using `composer`, the Upgrader tool updates the modules in groups. -Firstly it applies the security releases (the releases with security updates). For such releases only minor and patch versions are applied. The major releases will be applied after the module be updated to the major version. +Firstly, it applies the security releases (the releases with security updates). For such releases, only minor and patch versions are applied. The major releases are applied after the module is updated to the major version. After updating the modules, the Upgrader tool returns the list of updated modules and proceeds to the next step. If the Upgrader tool can’t update a module, it skips the module and the remaining groups. If all the groups failed to update, the Upgrader tool returns the errors causing this and stops. With at least one group updated, it returns the list of updated modules and proceeds to the next step. -By default, the Upgrader tool updates only minor and patch versions. When the Upgrader tool finds a group with a [major release](/docs/scos/dev/architecture/module-api/semantic-versioning-major-vs.-minor-vs.-patch-release.html#what-is-a-major-release), it won't update it and informs you about that (the exclusion only for the security major releases that silently skipped): +By default, the Upgrader tool updates only minor and patch versions. When the Upgrader tool finds a group with a [major release](/docs/scos/dev/architecture/module-api/semantic-versioning-major-vs.-minor-vs.-patch-release.html#what-is-a-major-release), it doesn't update it and informs you about that (the exclusion only for the security major releases that silently skipped): ```bash There is a major release available for module spryker/merchant-product-approval. From d8e5c1ed72d0b7c08cfbc3eba9a378481108d03e Mon Sep 17 00:00:00 2001 From: Vadym Sachenko Date: Mon, 24 Jul 2023 16:48:51 +0300 Subject: [PATCH 4/5] Update how-the-spryker-code-upgrader-works.md --- docs/scu/dev/how-the-spryker-code-upgrader-works.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/scu/dev/how-the-spryker-code-upgrader-works.md b/docs/scu/dev/how-the-spryker-code-upgrader-works.md index 177892896e2..0f5ccbd8e0d 100644 --- a/docs/scu/dev/how-the-spryker-code-upgrader-works.md +++ b/docs/scu/dev/how-the-spryker-code-upgrader-works.md @@ -12,14 +12,12 @@ To update a project, the Spryker Code Upgrader runs the following steps. ### 1. Identifies the available updates for the Spryker modules The Upgrader tool performs the following sub-steps: - 1. To identify the modules to be updated, it compares the information present in the `composer.json` and `composer.lock` files with our latest released code. - -2. It creates a list of modules and third-party libraries to be updated. Groups the modules according to how we released them. +2. It creates a list of modules and third-party libraries to be updated and groups the modules according to how we released them. {% info_block infoBox "Module groups" %} -As modules depend on other modules, we tend to release them in groups. When the Spryker Code Upgrader identifies a module to be updated, apart from the identified module, it also adds all the other related modules from its group to the list. +Because modules depend on other modules, we tend to release them in groups. When the Spryker Code Upgrader identifies a module to be updated, apart from the identified module, it also adds all the other related modules from its group to the list. {% endinfo_block %} @@ -32,7 +30,7 @@ Firstly, it applies the security releases (the releases with security updates). After updating the modules, the Upgrader tool returns the list of updated modules and proceeds to the next step. -If the Upgrader tool can’t update a module, it skips the module and the remaining groups. If all the groups failed to update, the Upgrader tool returns the errors causing this and stops. With at least one group updated, it returns the list of updated modules and proceeds to the next step. +If the Upgrader tool can’t update a module, it skips the module and the remaining groups. If all the groups fail to update, the Upgrader tool returns the errors causing this and stops. With at least one group updated, it returns the list of updated modules and proceeds to the next step. By default, the Upgrader tool updates only minor and patch versions. When the Upgrader tool finds a group with a [major release](/docs/scos/dev/architecture/module-api/semantic-versioning-major-vs.-minor-vs.-patch-release.html#what-is-a-major-release), it doesn't update it and informs you about that (the exclusion only for the security major releases that silently skipped): @@ -50,7 +48,7 @@ The Upgrader tool creates a separate Git branch to commit the changes to. The br ### 4. Commits the changes -Upgrader tool commits the changes in the `composer.json` and `composer.lock` files to the branch. +The Upgrader tool commits the changes in the `composer.json` and `composer.lock` files to the branch. ### 5. Pushes the changes From 4326a355db214aa324c59a383d3a6feeaf041340 Mon Sep 17 00:00:00 2001 From: AlexSlawinski Date: Tue, 8 Aug 2023 17:16:40 +0200 Subject: [PATCH 5/5] Update docs/scu/dev/how-the-spryker-code-upgrader-works.md --- docs/scu/dev/how-the-spryker-code-upgrader-works.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scu/dev/how-the-spryker-code-upgrader-works.md b/docs/scu/dev/how-the-spryker-code-upgrader-works.md index 0f5ccbd8e0d..1047716b2c2 100644 --- a/docs/scu/dev/how-the-spryker-code-upgrader-works.md +++ b/docs/scu/dev/how-the-spryker-code-upgrader-works.md @@ -26,7 +26,7 @@ Because modules depend on other modules, we tend to release them in groups. When Using `composer`, the Upgrader tool updates the modules in groups. -Firstly, it applies the security releases (the releases with security updates). For such releases, only minor and patch versions are applied. The major releases are applied after the module is updated to the major version. +Firstly, it applies the security releases (the releases with security updates). For these releases, only minor and patch versions are applied. The major releases are applied after the module is updated to the major version. After updating the modules, the Upgrader tool returns the list of updated modules and proceeds to the next step.