You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ca/devscu/manual-upgrade-alternatives/migration-sdk.md
+5-16Lines changed: 5 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,10 @@
1
1
---
2
2
title: Migration SDK
3
3
description: Learn how the open-source Migration SDK helps you plan and execute manual Spryker upgrades when the Spryker Code Upgrader cannot be used.
4
+
keywords: Upgrade, MigrationSDK.
4
5
template: howto-guide-template
5
6
---
6
7
7
-
## Overview
8
-
9
8
The **Migration SDK** is an open-source, community-developed tool that assists you in planning and executing manual upgrades of Spryker projects.
10
9
It analyzes your project and generates detailed reports, upgrade instructions, compatibility checks, and effort estimations.
11
10
@@ -14,11 +13,9 @@ Instead, it provides the data and guidance you need to perform updates manually
14
13
15
14
{% info_block warningBox "Warning" %}
16
15
The Migration SDK is a community-maintained tool. It is not officially supported or guaranteed by Spryker.
17
-
Use it at your own discretion. Contributions are welcome on [GitHub](https://github.com/spryker-projects/migration-program-sdk).
16
+
Use it at your own discretion. Contributions are welcome on GitHub: https://github.com/spryker-projects/migration-program-sdk
18
17
{% endinfo_block %}
19
18
20
-
---
21
-
22
19
## When to use the Migration SDK
23
20
24
21
Use the Migration SDK when:
@@ -28,11 +25,9 @@ Use the Migration SDK when:
28
25
- You need to perform a one-time manual upgrade to align your project with the latest Spryker version.
29
26
30
27
{% info_block infoBox "Tip" %}
31
-
After completing a manual upgrade using the Migration SDK, you can usually switch to the official **Spryker Code Upgrader** for future incremental updates.
28
+
After completing a manual upgrade using the Migration SDK, you can usually switch to the official Spryker Code Upgrader for future incremental updates.
32
29
{% endinfo_block %}
33
30
34
-
---
35
-
36
31
## Key capabilities
37
32
38
33
The Migration SDK offers a collection of PHP console scripts that automate analysis and planning tasks for manual upgrades.
@@ -54,8 +49,6 @@ The generated report helps you plan effort and identify risky or highly customiz
54
49
Detect potential compatibility issues, such as outdated PHP versions, missing plugins, or missing glossary keys.
55
50
Use these reports to resolve incompatibilities before running updates.
56
51
57
-
---
58
-
59
52
## Typical workflow
60
53
61
54
1. Clone the [Migration SDK repository](https://github.com/spryker-projects/migration-program-sdk).
@@ -66,19 +59,15 @@ Use these reports to resolve incompatibilities before running updates.
66
59
67
60
All scripts and configuration options are documented in detail in the [GitHub README](https://github.com/spryker-projects/migration-program-sdk).
68
61
69
-
---
70
-
71
62
## Example use cases
72
63
73
64
-**Project analysis:** Run the package analyzer to identify outdated modules before planning a major version upgrade.
74
65
-**Upgrade planning:** Use the update instruction generator to divide your update process into manageable groups.
75
66
-**Effort estimation:** Use the estimator report to predict development effort and prioritize modules.
76
67
-**Compatibility validation:** Check for missing plugins or glossary entries to prevent regressions.
Copy file name to clipboardExpand all lines: docs/ca/devscu/manual-upgrade-alternatives/when-and-why-to-do-manual-upgrade.md
+1-9Lines changed: 1 addition & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,9 @@ description: Learn when to use manual upgrade instead of the Spryker Code Upgrad
4
4
template: howto-guide-template
5
5
---
6
6
7
-
## Overview
8
-
9
7
The **Spryker Code Upgrader** is the primary and recommended tool for upgrading Spryker projects. It automates most upgrade steps, helping you keep your project aligned with the latest Spryker releases.
10
8
However, in some cases, you might need to perform a **manual upgrade**. This guide explains when that is necessary and introduces tools that can simplify the manual upgrade process.
11
9
12
-
---
13
-
14
10
## When to use a manual upgrade
15
11
16
12
You might choose a manual upgrade in the following cases:
@@ -19,8 +15,6 @@ You might choose a manual upgrade in the following cases:
19
15
-**Limited access** – You do not have entitlement or technical access to use the Spryker Code Upgrader.
20
16
-**Custom upgrade strategy** – You prefer full control over upgrade steps or have a custom development workflow that does not align with automated upgrades.
21
17
22
-
---
23
-
24
18
## What to expect from manual upgrading
25
19
26
20
Manual upgrades require you to analyze version differences, identify breaking changes, and apply updates directly in your codebase.
@@ -35,7 +29,6 @@ This process can take more time and effort than using the Spryker Code Upgrader,
35
29
Even when you perform a manual upgrade, follow the [Upgradability Guidelines](/docs/dg/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.html) to keep your project compatible with future releases.
36
30
37
31
{% endinfo_block %}
38
-
---
39
32
40
33
## How the Migration SDK can help
41
34
@@ -52,10 +45,9 @@ The Migration SDK does **not** modify your codebase or create merge requests. In
52
45
The Migration SDK is not officially maintained or supported by Spryker. It is provided as a community project and used at your own discretion.
53
46
Contributions are welcome on [GitHub](https://github.com/spryker-projects/migration-program-sdk).
54
47
{% endinfo_block %}
55
-
---
56
48
57
49
## Next steps
58
50
59
51
- Learn more about the [Migration SDK](migration-sdk.html).
60
52
- Read the [Upgradability Guidelines](/docs/dg/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.html) to keep your project easier to upgrade in the future.
61
-
- Review the [Spryker Code Upgrader](/docs/ca/devscu/spryker-code-upgrader/index.html) if your project meets the requirements for automated upgrades.
53
+
- Review the [Spryker Code Upgrader](/docs/ca/devscu/spryker-code-upgrader.html) if your project meets the requirements for automated upgrades.
0 commit comments