feat: add documentation for Plugin Store Authentication#2209
feat: add documentation for Plugin Store Authentication#2209Renaud Hager (renaudhager) wants to merge 3 commits intomainfrom
Conversation
Renaud Hager (renaudhager)
requested review from
Micha Hobert (Isengo1989),
Patrick Derks (TrayserCassa) and
Copilot
There was a problem hiding this comment.
Pull request overview
Adds a new Shopware PaaS Native documentation page describing how to configure Composer authentication for fetching plugins from the official Shopware plugin store and third-party repositories during build time.
Changes:
- Added a new “Plugin Store Authentication” fundamentals page.
- Documented use of
SHOPWARE_PACKAGES_TOKENandCOMPOSER_AUTHsecrets with example JSON payloads.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Third party plugin store | ||
| To authenticate against third party plugin store or plugin repository you need to create a secret named `COMPOSER_AUTH`. | ||
| The content need to be the json string required for the store/repository, run the following command: | ||
| ``` |
There was a problem hiding this comment.
This section has additional grammar/wording issues (e.g., missing hyphen in “Third party”, “content need”, “json” → “JSON”, and a run-on sentence before “run the following command”). Please adjust wording for clarity and consistent capitalization.
| ``` | ||
| sw-paas vault create --type buildenv --key COMPOSER_AUTH | ||
| ``` |
There was a problem hiding this comment.
This shell command block should also specify a language (e.g., ```sh) for consistency and syntax highlighting.
products/paas/shopware/fundamentals/plugins-store-authentication.md
Outdated
Show resolved
Hide resolved
| The build process might needs to authentication against plugins stores (Shopware official and any other one), this document explain how configure this authentication. | ||
|
|
||
| We rely on `composer` to fecth plugin during build time configured with two environment variables: `SHOPWARE_PACKAGES_TOKEN` and `COMPOSER_AUTH`. |
There was a problem hiding this comment.
There are several spelling/grammar issues in the intro that make it hard to understand (e.g., “might needs to authentication”, “plugins stores”, “document explain”, “fecth plugin”). Please rewrite these sentences for correct English (e.g., “might need to authenticate…”, “plugin stores…”, “this document explains…”, “fetch plugins…”).
| ``` | ||
| sw-paas vault create --type buildenv --key SHOPWARE_PACKAGES_TOKEN | ||
| ``` |
There was a problem hiding this comment.
Shell command code blocks should declare a language (e.g., ```sh) for consistency with the rest of the Shopware PaaS docs and for proper syntax highlighting.
products/paas/shopware/fundamentals/plugins-store-authentication.md
Outdated
Show resolved
Hide resolved
…on.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…on.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Renaud Hager (@renaudhager) can you please check the CoPilot hints and the failing tests, merci |
This pull request adds new documentation to help users configure authentication for plugin stores in Shopware during the build process. The document explains how to set up authentication for both the official Shopware plugin store and third-party plugin repositories using environment variables and secrets.
Documentation Additions:
plugins-store-authentication.md, outlining how to configure authentication for plugin stores during the build process, including steps for both the official Shopware plugin store and third-party stores.SHOPWARE_PACKAGES_TOKENandCOMPOSER_AUTH) to enable composer to fetch plugins securely.