[docs] Document deprecation of top-level url/admin_api in favor of environments - #2462
Conversation
…ironments Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Developer Docs healthcheckStatus: Completed with |
📢 Developer Announcement RecommendationRecommendation: ❌ No Announcement Recommended No developer announcement signals were detected.
|
There was a problem hiding this comment.
Pull request overview
Updates the Shopware CLI documentation to reflect the deprecation of top-level url/admin_api keys in .shopware-project.yml in favor of named environments (defaulting to environments.local).
Changes:
- Removed the stale top-level
urlexample from the dev environment configuration reference. - Documented that
url/admin_apishould live underenvironmentsand that the top-level keys are deprecated (with a CLI warning). - Clarified that
project config initwrites config underenvironments.local.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| guides/development/dev-environment.md | Removes deprecated top-level url sample and documents the preferred environments.* layout and default env behavior. |
| products/tools/cli/project-commands/helper-commands.md | Clarifies where project config init writes URL/Admin API credentials and documents the deprecation warning. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Follow-up docs for shopware/shopware-cli#1405 (author:
@shyim, merged via cursor[bot] PR).User-facing change
That PR deprecates the top-level
urlandadmin_apikeys in.shopware-project.ymlin favor of namedenvironments(an empty-e/--envnow defaults toenvironments.local).project createandproject config initnow only writeenvironments.local, and the CLI logs a deprecation warning when a config still uses the top-level keys.Documentation gap
Our config reference examples still showed a stale top-level
url:key alongsideenvironments.local, which contradicted the new deprecated/preferred layout, andproject config initdocs didn't mention where credentials are written or that the old keys are deprecated.Files changed
guides/development/dev-environment.md— removed the stale top-levelurlexample and added a note thaturl/admin_apiat the top level are deprecated in favor ofenvironments(empty-edefaults toenvironments.local).products/tools/cli/project-commands/helper-commands.md— clarified thatproject config initwritesenvironments.localand noted the deprecation warning for top-level keys.No other docs pages referenced the deprecated top-level layout in a way that needed changes.