Adds CLI notes from recent team walk-throughs and discussions - #2392
Adds CLI notes from recent team walk-throughs and discussions#2392somethings (lasomethingsomething) wants to merge 17 commits into
Conversation
Developer Docs healthcheckStatus: Completed with |
There was a problem hiding this comment.
Pull request overview
Adds additional operational context and usage notes across the Shopware CLI documentation pages to help readers understand common workflows (validation, store publishing, project tooling) and when to use particular commands.
Changes:
- Expanded CLI command explanations with more “why/when” context (validation, image proxy, anonymized dumps, project build/CI, refactoring).
- Added new practical notes and warnings for Store/Account workflows (local metadata management, “goes live immediately” warning, logout).
- Documented additional related commands and schema helpers (extension/project config schema, get-name, activate/deactivate).
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| products/tools/cli/validation.md | Adds more detailed explanation of what validation does and why to test lowest/highest constraints. |
| products/tools/cli/shopware-account-commands/updating-store-page.md | Adds guidance on tracking Store metadata in Git and warns about immediate visibility of pushes. |
| products/tools/cli/shopware-account-commands/releasing-extension-to-shopware-store.md | Clarifies upload workflow steps and CI/CD-oriented usage. |
| products/tools/cli/shopware-account-commands/configure-composer-repository.md | Reworks guidance around Composer/Store authentication (noted issues in review). |
| products/tools/cli/shopware-account-commands/authentication.md | Adds logout instructions and an additional producer listing command. |
| products/tools/cli/project-commands/remote-extension-management.md | Expands overview and adds activate/deactivate commands. |
| products/tools/cli/project-commands/mysql-dump.md | Adds anonymization rationale, usage example, and updates config file reference. |
| products/tools/cli/project-commands/image-proxy.md | Adds problem statement and clearer behavior description; improves usage note. |
| products/tools/cli/project-commands/helper-commands.md | Adds notes about --no-audit, admin build/watch behavior, worker usage, and project utilities (noted issue in review). |
| products/tools/cli/project-commands/build.md | Adds “most-used command” context, CI platform flag overview, and SBOM explanation. |
| products/tools/cli/project-commands/autofix.md | Clarifies version context for Symfony Flex migration and improves Composer migration section. |
| products/tools/cli/index.md | Adds telemetry overview and links to telemetry reference. |
| products/tools/cli/extension-commands/extract-meta-data.md | Adds get-name and extension config schema command documentation. |
| products/tools/cli/extension-commands/configuration.md | Mentions schema extraction command for .shopware-extension.yml. |
| products/tools/cli/extension-commands/build.md | Adds esbuild-related asset hashing/Vite manifest notes and expands release-mode explanation (noted issue in review). |
| products/tools/cli/automatic-refactoring.md | Expands motivation and adds options examples for project fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Micha Hobert (Isengo1989)
added
the
Improvement
|
Soner (@shyim) I just updated references to |
| # .shopware-extension.yml | ||
| build: | ||
| zip: | ||
| package: |
There was a problem hiding this comment.
this did not changed, we just renamed the command
There was a problem hiding this comment.
Soner (@shyim) OK, I'll change those code snippets back to zip then. brb
There was a problem hiding this comment.
Soner (@shyim) Reverted zip => package in the code blocks back to zip
| - Merges snippets of extensions to speed up Administration | ||
| - Generates a Software Bill of Materials (SBOM) listing all deployed dependencies | ||
|
|
||
| ## CI system configuration |
There was a problem hiding this comment.
this happens automatically. not needed by user to specify
|
Copilot resolve the merge conflicts in this pull request |
Merge conflicts have been resolved in commit |
Summary
Adds mostly small snippets of context across the CLI pages.
Related links
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.Notes