From 8b1ca1ba92d8d8cb45ccb8de445fc78ad62d3c3d Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 12 May 2026 06:00:11 +0000 Subject: [PATCH 1/3] docs(deployment-helper): document new `deployment.staging.enabled` config Document the `deployment.staging.enabled` option and the matching `SHOPWARE_DEPLOYMENT_STAGING` environment variable, added in shopware/deployment-helper@66cf244. When enabled, the Deployment Helper runs `system:setup:staging --no-interaction --force` automatically during deployment. --- .../deployments/deployment-helper.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/guides/hosting/installation-updates/deployments/deployment-helper.md b/guides/hosting/installation-updates/deployments/deployment-helper.md index 7b01e1919..784f7cbeb 100644 --- a/guides/hosting/installation-updates/deployments/deployment-helper.md +++ b/guides/hosting/installation-updates/deployments/deployment-helper.md @@ -141,6 +141,12 @@ deployment: store: license-domain: 'example.com' + + # Automatically runs `system:setup:staging --no-interaction --force` after deployment, + # before extensions are managed. Use this on staging environments so the instance is + # switched into staging mode on every deploy. See "Staging Mode Integration" below. + staging: + enabled: false ``` ## Local Configuration Overrides @@ -219,6 +225,7 @@ Additionally, you can configure the Shopware installation using the following en - `SHOPWARE_STORE_ACCOUNT_PASSWORD` - The password of the Shopware account - `SHOPWARE_STORE_LICENSE_DOMAIN` - The license domain of the Shopware Shop (default: license-domain value in YAML file) - `SHOPWARE_USAGE_DATA_CONSENT` - Controls Shopware Usage Data sharing (`accepted` or `revoked`), overwrites Administration choice +- `SHOPWARE_DEPLOYMENT_STAGING` - Set to `1` to enable staging mode (equivalent to `deployment.staging.enabled: true` in `.shopware-project.yml`) ## Extension Management and Store-installed Plugins @@ -263,6 +270,26 @@ You can check with `./vendor/bin/shopware-deployment-helper one-time-task:list` To remove a task, use `./vendor/bin/shopware-deployment-helper one-time-task:unmark `. This will cause the task to be executed again during the next update. To manually mark a task as run you can use `./vendor/bin/shopware-deployment-helper one-time-task:mark `. +## Staging Mode Integration + +On a staging environment, you usually want Shopware's staging mode to be (re-)applied every time the database is refreshed from production, so emails stay disabled, app connections are reset, URLs are rewritten, and so on. The Deployment Helper can do this for you automatically. + +Enable it either in `.shopware-project.yml`: + +```yaml +deployment: + staging: + enabled: true +``` + +…or via the environment variable `SHOPWARE_DEPLOYMENT_STAGING=1`. The latter is convenient when the same `.shopware-project.yml` is shared between production and staging — set the env variable only on the staging environment. + +When enabled, the Deployment Helper runs `system:setup:staging --no-interaction --force` during deployment, before extensions are managed, for both the install and update flows. To configure what staging mode actually changes (banners, URL rewriting, email delivery, ElasticSearch checks, etc.), see [Creating a Staging Instance](../creating-a-staging-instance.md#configuring-staging-mode). + +:::warning +Do not enable this on your production environment. `system:setup:staging` is a destructive operation that, among other things, deletes apps with active external connections and disables email delivery. +::: + ## Fastly Integration The Deployment Helper can also deploy Fastly VCL Snippets for you and keep them up to date. After installing the Deployment Helper, you can install the Fastly meta package: From 9663ceedae36ff1c2f6a17659447d8c92711eb6e Mon Sep 17 00:00:00 2001 From: Soner Date: Tue, 12 May 2026 08:10:13 +0200 Subject: [PATCH 2/3] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .../installation-updates/deployments/deployment-helper.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/hosting/installation-updates/deployments/deployment-helper.md b/guides/hosting/installation-updates/deployments/deployment-helper.md index 784f7cbeb..9a58eda61 100644 --- a/guides/hosting/installation-updates/deployments/deployment-helper.md +++ b/guides/hosting/installation-updates/deployments/deployment-helper.md @@ -272,7 +272,7 @@ To manually mark a task as run you can use `./vendor/bin/shopware-deployment-hel ## Staging Mode Integration -On a staging environment, you usually want Shopware's staging mode to be (re-)applied every time the database is refreshed from production, so emails stay disabled, app connections are reset, URLs are rewritten, and so on. The Deployment Helper can do this for you automatically. +On a staging environment, you usually want Shopware's staging mode to be applied again every time the database is refreshed from production, so emails stay disabled, app connections are reset, URLs are rewritten, and so on. The Deployment Helper can do this for you automatically. Enable it either in `.shopware-project.yml`: From 321335bff805a5faa11675e0c42d25dfacefc231 Mon Sep 17 00:00:00 2001 From: Micha Date: Tue, 12 May 2026 10:58:35 +0200 Subject: [PATCH 3/3] fix/small-grammar --- .../deployments/deployment-helper.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/guides/hosting/installation-updates/deployments/deployment-helper.md b/guides/hosting/installation-updates/deployments/deployment-helper.md index 9a58eda61..8c4290b31 100644 --- a/guides/hosting/installation-updates/deployments/deployment-helper.md +++ b/guides/hosting/installation-updates/deployments/deployment-helper.md @@ -27,7 +27,7 @@ vendor/bin/shopware-deployment-helper run ## What does the Deployment Helper exactly do? -The Deployment Helper checks for you, if Shopware is installed and if not, it will install it for you. +The Deployment Helper checks for you if Shopware is installed, and if not, it will install it for you. It will also check if the database server is accessible, and if not, it will wait until it is. Besides installing or updating Shopware, it also simplifies common tasks which normally are executed during the deployment like: @@ -143,8 +143,8 @@ deployment: license-domain: 'example.com' # Automatically runs `system:setup:staging --no-interaction --force` after deployment, - # before extensions are managed. Use this on staging environments so the instance is - # switched into staging mode on every deploy. See "Staging Mode Integration" below. + # before extensions are managed. Use this on staging environments, so the instance is + # switched into staging mode on every deployment. See "Staging Mode Integration" below. staging: enabled: false ``` @@ -264,7 +264,7 @@ With this setting, the Deployment Helper will skip extension installation and up ## One Time Tasks -One time tasks are tasks that should be executed only once during the deployment, like a migration script. +One-time tasks are tasks that should be executed only once during the deployment, like a migration script. You can check with `./vendor/bin/shopware-deployment-helper one-time-task:list` which tasks were executed and when. To remove a task, use `./vendor/bin/shopware-deployment-helper one-time-task:unmark `. This will cause the task to be executed again during the next update. @@ -272,7 +272,7 @@ To manually mark a task as run you can use `./vendor/bin/shopware-deployment-hel ## Staging Mode Integration -On a staging environment, you usually want Shopware's staging mode to be applied again every time the database is refreshed from production, so emails stay disabled, app connections are reset, URLs are rewritten, and so on. The Deployment Helper can do this for you automatically. +In a staging environment, you usually want Shopware's staging mode to be applied again every time the database is refreshed from production, so emails stay disabled, app connections are reset, URLs are rewritten, and so on. The Deployment Helper can do this for you automatically. Enable it either in `.shopware-project.yml`: @@ -284,7 +284,7 @@ deployment: …or via the environment variable `SHOPWARE_DEPLOYMENT_STAGING=1`. The latter is convenient when the same `.shopware-project.yml` is shared between production and staging — set the env variable only on the staging environment. -When enabled, the Deployment Helper runs `system:setup:staging --no-interaction --force` during deployment, before extensions are managed, for both the install and update flows. To configure what staging mode actually changes (banners, URL rewriting, email delivery, ElasticSearch checks, etc.), see [Creating a Staging Instance](../creating-a-staging-instance.md#configuring-staging-mode). +When enabled, the Deployment Helper runs `system:setup:staging --no-interaction --force` during deployment, before extensions are managed, for both the installation and update flows. To configure what staging mode actually changes (banners, URL rewriting, email delivery, ElasticSearch checks, etc.), see [Creating a Staging Instance](../creating-a-staging-instance.md#configuring-staging-mode). :::warning Do not enable this on your production environment. `system:setup:staging` is a destructive operation that, among other things, deletes apps with active external connections and disables email delivery. @@ -322,10 +322,10 @@ To find the name (for example `SwagPlatformDemoData`) of the extension you want Shopware Plugin Service ======================= - ----------------------------- ------------------------------------------ ---------------------------------------------- --------- ----------------- ------------------- ----------- -------- ------------- ---------------------- - Plugin Label Composer name Version Upgrade version Author Installed Active Upgradeable Required by composer ----------------------------- ------------------------------------------ ---------------------------------------------- --------- ----------------- ------------------- ----------- -------- ------------- ---------------------- - SwagPlatformDemoData Shopware 6 Demo data swag/demo-data 2.0.1 shopware AG Yes No No No + Plugin Label Composer name Version Upgrade version Author Installed Active Upgradeable Required by composer + ----------------------------- ------------------------------------------ ---------------------------------------------- --------- ----------------- ------------------- ----------- -------- ------------- ---------------------- + SwagPlatformDemoData Shopware 6 Demo data swag/demo-data 2.0.1 shopware AG Yes No No No ----------------------------- ------------------------------------------ ---------------------------------------------- --------- ----------------- ------------------- ----------- -------- ------------- ---------------------- ```