docs(deployment-helper): fix env var names, execution flow, and add missing config#2332
Open
Soner (shyim) wants to merge 4 commits into
Open
docs(deployment-helper): fix env var names, execution flow, and add missing config#2332Soner (shyim) wants to merge 4 commits into
Soner (shyim) wants to merge 4 commits into
Conversation
…issing config - Fix FASTLY_API_KEY -> FASTLY_API_TOKEN (code reads FASTLY_API_TOKEN) - Fix staging mode execution order: runs as PostDeploy listener, not before extensions - Add deployment.maintenance.enabled and deployment.cache.always_clear to YAML reference - Update mermaid diagram to reflect conditional maintenance mode - Add missing env vars: INSTALL_ADMIN_EMAIL, APP_URL, SHOPWARE_DEPLOYMENT_FORCE_REINSTALL, SHOPWARE_STORE_SHOP_SECRET, SHOPWARE_PROJECT_CONFIG_FILE, FASTLY_API_TOKEN, FASTLY_SERVICE_ID, DATABASE_URL, DO_NOT_TRACK, SHOPWARE_TRACKING_DOMAIN - Document all CLI commands and run command options - Add fastly:snippet:deploy command to Fastly section Fixes #
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Deployment Helper documentation to align configuration keys, environment variable names, and the described execution flow with the current deployment-helper behavior.
Changes:
- Added CLI reference tables for available commands and
runoptions. - Updated execution-flow documentation (including mermaid diagram and staging mode order) and documented missing YAML config keys.
- Expanded the environment variable reference and corrected Fastly integration docs to use
FASTLY_API_TOKEN.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Audit Findings & Fixes
Cross-referenced the docs against the deployment-helper source codebase.
🔴 Critical Fixes
FASTLY_API_KEY→FASTLY_API_TOKEN— The code readsFASTLY_API_TOKENin all 6 locations. Following the old docs would cause Fastly integration to silently skip with no error.Staging mode execution order — Docs said staging runs "before extensions";
StagingSetupSubscriberis aPostDeploylistener that runs after everything. Fixed both the YAML comment and the dedicated section.🟡 Missing from YAML Reference
deployment.maintenance.enabled— Implemented but undocumented; gates maintenance mode during updates (defaultsfalse)deployment.cache.always_clear— ImplementedClearAlwaysCacheSubscriberbut config key was missing from docs🟡 Execution Flow Diagram
maintenance.enabled🟢 Missing Environment Variables
Added 10 undocumented env vars that are actively used in code:
INSTALL_ADMIN_EMAIL,APP_URL,SHOPWARE_DEPLOYMENT_FORCE_REINSTALL,SHOPWARE_STORE_SHOP_SECRET,SHOPWARE_PROJECT_CONFIG_FILE,FASTLY_API_TOKEN,FASTLY_SERVICE_ID,DATABASE_URL,DO_NOT_TRACK,SHOPWARE_TRACKING_DOMAIN🟢 CLI Commands & Options
--skip-theme-compile,--skip-assets-install,--timeout,--project-configfastly:snippet:deployto the Fastly commands list