Skip to content

[docs] Document deprecation of top-level url/admin_api in favor of environments - #2462

Open
shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/pr-1405-env-config-deprecation-7cdfba24deddaf3d
Open

[docs] Document deprecation of top-level url/admin_api in favor of environments#2462
shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/pr-1405-env-config-deprecation-7cdfba24deddaf3d

Conversation

@shopware-docs-updater

Copy link
Copy Markdown
Contributor

Follow-up docs for shopware/shopware-cli#1405 (author: @shyim, merged via cursor[bot] PR).

User-facing change

That PR deprecates the top-level url and admin_api keys in .shopware-project.yml in favor of named environments (an empty -e/--env now defaults to environments.local). project create and project config init now only write environments.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 alongside environments.local, which contradicted the new deprecated/preferred layout, and project config init docs 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-level url example and added a note that url/admin_api at the top level are deprecated in favor of environments (empty -e defaults to environments.local).
  • products/tools/cli/project-commands/helper-commands.md — clarified that project config init writes environments.local and noted the deprecation warning for top-level keys.

No other docs pages referenced the deprecated top-level layout in a way that needed changes.

Generated by 📝 PR documentation check for #1405 · auto · 52.5 AIC · ⌖ 3.57 AIC · ⊞ 7.6K ·

…ironments

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Aug 19, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 312013c
Preview: https://developer-documentation-kgkzsemmx-shopware-frontends.vercel.app
Workflow run: #4924

@shyim
Soner (shyim) marked this pull request as ready for review August 20, 2026 05:02
Copilot AI lite review requested due to automatic review settings August 20, 2026 05:02
@github-actions

Copy link
Copy Markdown
Contributor

📢 Developer Announcement Recommendation

Recommendation: ❌ No Announcement Recommended

No developer announcement signals were detected.

This PR does not appear to introduce developer-facing changes that require a community announcement.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 url example from the dev environment configuration reference.
  • Documented that url/admin_api should live under environments and that the top-level keys are deprecated (with a CLI warning).
  • Clarified that project config init writes config under environments.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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant