docs: document project upgrade wizard - #2442
Open
somethings (lasomethingsomething) wants to merge 7 commits into
Open
docs: document project upgrade wizard#2442somethings (lasomethingsomething) wants to merge 7 commits into
somethings (lasomethingsomething) wants to merge 7 commits into
Conversation
Developer Docs healthcheckStatus: Completed with |
somethings (lasomethingsomething)
requested a review
from Tomasz Turkowski (tturkowski)
August 13, 2026 12:43
somethings (lasomethingsomething)
marked this pull request as ready for review
August 13, 2026 15:39
somethings (lasomethingsomething)
requested review from
Soner (shyim)
and
a lite review from Copilot
August 13, 2026 15:39
Copilot started reviewing on behalf of
somethings (lasomethingsomething)
August 13, 2026 15:40
View session
somethings (lasomethingsomething)
requested a review
from Micha Hobert (Isengo1989)
August 13, 2026 15:42
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds canonical documentation for the shopware-cli project upgrade wizard (local-first Shopware project upgrades) and makes it discoverable from the existing upgrade and operational update guides.
Changes:
- Add a new CLI guide describing the upgrade wizard phases, prerequisites, rollback behavior, dry-run/preflight mode, and report output.
- Update upgrade and update guides to recommend the wizard workflow and link to the canonical CLI documentation.
- Extend the spellcheck wordlist to include “preflight”.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| products/tools/cli/project-commands/upgrade.md | New canonical documentation for the Shopware CLI project upgrade wizard, including phases, non-interactive preflight, rollback, and reporting. |
| guides/upgrades-migrations/upgrade-shopware.md | Reframes the guide to recommend the CLI wizard for local upgrade preparation, while keeping the manual Composer workflow as fallback. |
| guides/upgrades-migrations/index.md | Adds an entry-point callout and integrates the CLI preflight into the typical upgrade workflow and next steps. |
| guides/hosting/installation-updates/performing-updates.md | Updates operational update guidance to use the wizard (dry-run and interactive) for compatibility checks and local preparation steps. |
| .wordlist.txt | Adds “preflight” to the spelling allowlist. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| After you choose a target, the wizard combines two kinds of compatibility information: | ||
|
|
||
| - Extension and repository metadata provides an early compatibility signal. |
| ``` | ||
|
|
||
| This command checks your installed extensions against the target Shopware version. If an extension is not compatible, check with the extension developer if an update is available. If you don't have the Shopware CLI installed, see the [installation guide](../../../products/tools/cli/index.md). | ||
| For an interactive target picker and guided workflow, run: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changed?
shopware-cli project upgradeImplementation source
Documents the local-first upgrade work from:
Placement
The canonical feature reference lives under
products/tools/cli/project-commands/upgrade.md.The PR also updates:
guides/upgrades-migrations/upgrade-shopware.mdguides/upgrades-migrations/index.mdguides/hosting/installation-updates/performing-updates.mdThis keeps the detailed command behavior in the CLI docs while making the wizard discoverable from the places developers already go when planning an upgrade.
Rollout
This is intentionally a draft.
project upgradeis merged on the Shopware CLInextbranch, while the current stable CLI release is still0.16.10. The docs should land with or after the release containing the upgrade wizard.Notes
The guide treats Composer resolution as the authoritative dependency gate and Store/repository metadata as an early compatibility signal, matching the current implementation. It also makes the local-first boundary explicit: the wizard upgrades the local project, then the developer tests, commits, and deploys through the normal process.