Skip to content

Document staging mode integration in deployment helper#2282

Open
Soner (shyim) wants to merge 2 commits into
mainfrom
claude/update-deployment-docs-rQwZm
Open

Document staging mode integration in deployment helper#2282
Soner (shyim) wants to merge 2 commits into
mainfrom
claude/update-deployment-docs-rQwZm

Conversation

@shyim
Copy link
Copy Markdown
Member

Summary

This documentation update adds comprehensive information about the Deployment Helper's staging mode integration feature, including:

  • Configuration option deployment.staging.enabled in .shopware-project.yml
  • Environment variable SHOPWARE_DEPLOYMENT_STAGING for enabling staging mode
  • New "Staging Mode Integration" section explaining the feature, its purpose, and usage
  • Warning about not enabling staging mode on production environments

Related links

N/A

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.

Notes

This is a documentation-only change that documents an existing feature. The changes include:

  • Added YAML configuration example for the staging mode setting
  • Added environment variable documentation
  • Added a new "Staging Mode Integration" section with usage instructions and a production warning
  • Cross-references the "Creating a Staging Instance" guide for configuration details

https://claude.ai/code/session_01LhhqG8dcRv5yyxahgABuuE

…nfig

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.
Copilot AI review requested due to automatic review settings May 12, 2026 06:06
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

Documents the Deployment Helper’s existing staging mode integration so users can enable staging mode automatically during deploys via YAML configuration or an environment variable, with guidance to avoid using it in production.

Changes:

  • Adds .shopware-project.yml configuration example for deployment.staging.enabled.
  • Documents SHOPWARE_DEPLOYMENT_STAGING=1 as an environment-variable equivalent.
  • Introduces a new “Staging Mode Integration” section explaining behavior, usage, and a production warning.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread guides/hosting/installation-updates/deployments/deployment-helper.md Outdated
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.

3 participants