Skip to content

Improve extension maintenance and Store workflows - #2443

Open
somethings (lasomethingsomething) wants to merge 12 commits into
mainfrom
docs/extension-maintenance-store-workflows
Open

Improve extension maintenance and Store workflows#2443
somethings (lasomethingsomething) wants to merge 12 commits into
mainfrom
docs/extension-maintenance-store-workflows

Conversation

@lasomethingsomething

@lasomethingsomething somethings (lasomethingsomething) commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Improve existing extension documentation around maintenance and Store release workflows by making current capabilities easier to discover and clarifying where automation stops.

This draft PR:

  • clarifies the sequence from local validation through Store automatic code review and any remaining Store review;
  • removes wording that could imply the complete Store release lifecycle is fully automated by the CLI;
  • positions Store listing metadata as a version-controlled workflow using the existing extension info pull and extension info push commands;
  • surfaces common extension creation, validation, maintenance, Store metadata, release, and upgrade entry points from the existing Extensions landing page;
  • modernizes the plugin-dependency guidance and example constraints;
  • documents the trade-offs of using a shared foundation across related extensions.

Scope

This only updates existing documentation pages. It does not add new pages or document unreleased functionality.

Motivation

Recent developer research highlighted two recurring documentation gaps:

  1. Existing tooling and workflows can be difficult to discover from the main extension documentation paths.
  2. The boundary between local CLI validation, automatic Store code review, and the remaining Store review process is easy to misunderstand.

The goal is to improve discoverability and reduce ambiguity without duplicating guidance that already exists elsewhere in the docs.

Files updated

  • guides/development/extensions/code-structure.md
  • guides/development/extensions/index.md
  • guides/plugins/plugins/dependencies/add-plugin-dependencies.md
  • products/tools/cli/shopware-account-commands/releasing-extension-to-shopware-store.md
  • products/tools/cli/shopware-account-commands/updating-store-page.md

Validation

  • Reviewed the changes against the current documentation structure and existing cross-links.
  • Full repository CI and docs preview have not been run in this environment.

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

@shopware-dev-docs-connector

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

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: fa390a8
Preview: https://developer-documentation-fgk6s3tg3-shopware-frontends.vercel.app
Workflow run: #4821

@lasomethingsomething
somethings (lasomethingsomething) marked this pull request as ready for review August 14, 2026 11:14
Copilot AI lite review requested due to automatic review settings August 14, 2026 11:14

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

This PR refines Shopware extension documentation to make maintenance and Shopware Store workflows easier to discover, and to more clearly separate what the Shopware CLI automates (local validation, uploading, metadata sync) from what still happens inside the Store review/publication process.

Changes:

  • Reworks the “update Store page” guidance to frame Store listing metadata as a version-controlled workflow (extension info pull/push), including where it fits into a release.
  • Expands and clarifies the Store upload/review flow, focusing on what the CLI does vs. what the Store still controls.
  • Modernizes plugin dependency guidance and adds new “shared foundations / extension families” structure guidance plus workflow entry points from the Extensions landing page.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
products/tools/cli/shopware-account-commands/updating-store-page.md Reframes Store listing metadata as code and adds a release context section for info pull/push.
products/tools/cli/shopware-account-commands/releasing-extension-to-shopware-store.md Clarifies upload/review behavior and adds CI guidance about waiting/polling for review results.
guides/plugins/plugins/dependencies/add-plugin-dependencies.md Updates dependency explanation and examples; adds guidance on shared foundation trade-offs and alternatives.
guides/development/extensions/index.md Adds a “Common extension workflows” section to improve discoverability of key entry points.
guides/development/extensions/code-structure.md Adds guidance for shared foundations/extension families and dependency minimization for upgrades.
Suppressed comments (1)

products/tools/cli/shopware-account-commands/releasing-extension-to-shopware-store.md:8

  • The H1 repeats "Automatically Release", which can be read as implying final publication/approval is automated, even though the page explains manual Store steps may still apply.
# Automatically Release an Extension to the Shopware Store

💡 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>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.

2 participants