Skip to content

docs: add app requirements feature#2238

Merged
Micha Hobert (Isengo1989) merged 7 commits intomainfrom
docs/app-requirements
Apr 15, 2026
Merged

docs: add app requirements feature#2238
Micha Hobert (Isengo1989) merged 7 commits intomainfrom
docs/app-requirements

Conversation

@Gaitholabi
Copy link
Copy Markdown
Contributor

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 new public-access requirement.

Clarifications and environment-specific behavior:

  • Noted that requirements validation is available since Shopware 6.7.10.0, and that validation is skipped in dev and test environments to avoid blocking development and CI.

These changes help app developers understand how to use requirements for more robust app installation and validation.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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-access details.
  • 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.

Comment thread resources/references/app-reference/manifest-reference.md
Comment thread guides/plugins/apps/app-registration-setup.md Outdated
@Isengo1989 Micha Hobert (Isengo1989) added the Undocumented Feature Feature which is not documented yet and is considered for documentation label Apr 13, 2026
Comment thread resources/references/app-reference/manifest-reference.md Outdated
Copy link
Copy Markdown
Contributor

@Isengo1989 Micha Hobert (Isengo1989) left a comment

Choose a reason for hiding this comment

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

Thx for the PR Ghaith (@Gaitholabi) 👍

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.

Thank you Ghaith (@Gaitholabi) -- some small edits

Comment thread guides/plugins/apps/app-registration-setup.md Outdated
Comment thread guides/plugins/apps/app-registration-setup.md Outdated
Comment thread resources/references/app-reference/manifest-reference.md Outdated
@Isengo1989
Copy link
Copy Markdown
Contributor

Due to this PR -> #2237 a merge conflict appeared

@Gaitholabi
Copy link
Copy Markdown
Contributor Author

Ghaith (Gaitholabi) commented Apr 15, 2026

Due to this PR -> #2237 a merge conflict appeared

Done ✔️

@Isengo1989
Copy link
Copy Markdown
Contributor

Due to this PR -> #2237 a merge conflict appeared

Done ✔️

Almost 🙂 -> 2268cba

Fixed the internal links. Ready to be merged IMO - feel free to do so if you see fit in the timeline of releases/planning 👍

@Gaitholabi
Copy link
Copy Markdown
Contributor Author

Ghaith (Gaitholabi) commented Apr 15, 2026

Due to this PR -> #2237 a merge conflict appeared

Done ✔️

Almost 🙂 -> 2268cba

Fixed the internal links. Ready to be merged IMO - feel free to do so if you see fit in the timeline of releases/planning 👍

we should be okay to merge from my end, we clearly highlight that it's available since/starting 6.7.10.0

Though I can't merge myself, as I don't have write access to the repository

Merging is blocked
You're not authorized to push to this branch. Visit https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches for more information.

@Isengo1989 Micha Hobert (Isengo1989) merged commit b8d9ec5 into main Apr 15, 2026
8 checks passed
@Isengo1989 Micha Hobert (Isengo1989) deleted the docs/app-requirements branch April 15, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Undocumented Feature Feature which is not documented yet and is considered for documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants