docs: add app requirements feature#2238
Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new Shopware App “requirements” feature, explaining how to declare requirements in manifest.xml, when Shopware validates them, and documenting the initial public-access requirement.
Changes:
- Add a new manifest snippet showing
<requirements>usage. - Extend the manifest reference with a “Requirements” section and
public-accessdetails. - Extend the app registration/setup guide with a dedicated “Requirements” section, including environment-specific validation behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| snippets/config/app/requirements.xml | New snippet demonstrating the <requirements> manifest element. |
| resources/references/app-reference/manifest-reference.md | Adds “Requirements” + documents public-access validator behavior. |
| guides/plugins/apps/app-registration-setup.md | Adds requirements overview, usage example, and notes about validation behavior in prod vs dev/test. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Micha Hobert (Isengo1989)
left a comment
There was a problem hiding this comment.
Thx for the PR Ghaith (@Gaitholabi) 👍
somethings (lasomethingsomething)
left a comment
There was a problem hiding this comment.
Thank you Ghaith (@Gaitholabi) -- some small edits
4f25783 to
77576ba
Compare
|
Due to this PR -> #2237 a merge conflict appeared |
Co-authored-by: somethings <l.apple@shopware.com>
77576ba to
ea8c0cc
Compare
Done ✔️ |
we should be okay to merge from my end, we clearly highlight that it's available since/starting Though I can't merge myself, as I don't have write access to the repository
|
This pull request updates the app registration and manifest documentation to introduce and explain the new "requirements" feature for Shopware apps. It describes how apps can declare requirements in their
manifest.xml, how Shopware validates these during installation and updates, and provides details on the available requirements, including the newpublic-accessrequirement.Clarifications and environment-specific behavior:
devandtestenvironments to avoid blocking development and CI.These changes help app developers understand how to use requirements for more robust app installation and validation.