chore: adjust shopware-cli and deployment-helper configuration file locations - #2521
Open
Malte Janz (MalteJanz) wants to merge 5 commits into
Conversation
Developer Docs healthcheckStatus: Completed with |
Contributor
Author
There was a problem hiding this comment.
Disclaimer: This PR should only be merged after both of these are merged + released:
shopware/shopware-cli#1432
shopware/deployment-helper#114
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Several examples conflict with legacy-path behavior, packaging behavior, or the availability of the unreleased upstream implementations.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Documents the new preferred .config/ locations and legacy lookup behavior for Shopware CLI and Deployment Helper configuration files.
Changes:
- Adds a centralized configuration lookup reference.
- Updates project and extension examples to use
.config/. - Revises Deployment Helper, development, PaaS, and plugin guidance.
File summaries
| File | Description |
|---|---|
products/tools/cli/validation.md |
Updates validation configuration paths |
products/tools/cli/shopware-account-commands/updating-store-page.md |
Updates Store metadata paths |
products/tools/cli/project-commands/remote-extension-management.md |
Updates project configuration references |
products/tools/cli/project-commands/mysql-dump.md |
Updates dump configuration examples |
products/tools/cli/project-commands/image-proxy.md |
Updates image proxy configuration |
products/tools/cli/project-commands/helper-commands.md |
Updates schema and initialization guidance |
products/tools/cli/project-commands/dev-environment.md |
Updates development environment paths |
products/tools/cli/project-commands/build.md |
Updates build configuration references |
products/tools/cli/extension-commands/extract-meta-data.md |
Updates extension schema documentation |
products/tools/cli/extension-commands/configuration.md |
Updates extension configuration guidance |
products/tools/cli/extension-commands/build.md |
Updates extension build examples |
products/tools/cli/configuration.md |
Adds lookup priority and migration reference |
products/paas/shopware/get-started/prepare-codebase.md |
Updates PaaS extension-removal guidance |
guides/plugins/plugins/bundle.md |
Updates project structure and bundle configuration |
guides/hosting/installation-updates/extension-management.md |
Updates Deployment Helper path |
guides/hosting/installation-updates/deployments/deployment-helper/troubleshooting.md |
Updates troubleshooting paths |
guides/hosting/installation-updates/deployments/deployment-helper/store.md |
Updates Store configuration path |
guides/hosting/installation-updates/deployments/deployment-helper/staging.md |
Updates staging configuration paths |
guides/hosting/installation-updates/deployments/deployment-helper/reference.md |
Updates command reference paths |
guides/hosting/installation-updates/deployments/deployment-helper/hosting.md |
Updates hosting configuration paths |
guides/hosting/installation-updates/deployments/deployment-helper/extensions.md |
Updates extension-management paths |
guides/hosting/installation-updates/deployments/deployment-helper/environment.md |
Updates configuration environment-variable description |
guides/hosting/installation-updates/deployments/deployment-helper/configuration.md |
Updates primary and local configuration guidance |
guides/hosting/installation-updates/creating-a-staging-instance.md |
Updates dump configuration path |
guides/development/dev-environment.md |
Updates development and migration documentation |
Review details
- Files reviewed: 25/25 changed files
- Comments generated: 7
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Malte Janz (MalteJanz)
marked this pull request as ready for review
September 17, 2026 09:59
Malte Janz (MalteJanz)
requested review from
a team,
Anne (Ant1gua),
somethings (lasomethingsomething),
Lena Forlin (moshimorschi),
Soner (shyim),
Su (sushmangupta) and
Tomasz Turkowski (tturkowski)
and removed request for
a team
September 17, 2026 09:59
somethings (lasomethingsomething)
approved these changes
Sep 17, 2026
somethings (lasomethingsomething)
left a comment
somethings (lasomethingsomething)
left a comment
Contributor
There was a problem hiding this comment.
Two small suggestions, otherwise lgtm
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.
Summary
Adjustments made to document the new priority based lookup of the shopware-project and shopware-extension YAML config files and their new default location for new projects. For additional context read the ADR, TLDR: we want to adopt the .config convention
Related links
.config/shopware-cli#1387Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.Notes