Skip to content

[#1654] Added config verification check to provision.sh. #2304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexSkrypnyk merged 1 commit into from
Feb 18, 2026
Merged

[#1654] Added config verification check to provision.sh. #2304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,12 @@ VORTEX_PROVISION_OVERRIDE_DB=0
# is not available.
VORTEX_PROVISION_FALLBACK_TO_PROFILE=0

# Verify that configuration was not changed by database updates.
# If enabled and config files are present, the provision will fail if
# database update hooks modify active configuration, preventing
# drush config:import from silently overwriting those changes.
VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE=0

# Skip database sanitization.
#
# Database sanitization is enabled by default in all non-production
Expand Down
1 change: 1 addition & 0 deletions .vortex/docs/content/development/variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,7 @@ The list below is automatically generated with [Shellvar](https://github.com/ale
| <a id="vortex_provision_skip"></a>`VORTEX_PROVISION_SKIP` | Flag to skip site provisioning. | `UNDEFINED` | `scripts/vortex/provision.sh` |
| <a id="vortex_provision_type"></a>`VORTEX_PROVISION_TYPE` | Set to 'profile' to install a site from profile instead of the database dump. | `database` | `.env`, `scripts/vortex/provision.sh` |
| <a id="vortex_provision_use_maintenance_mode"></a>`VORTEX_PROVISION_USE_MAINTENANCE_MODE` | Put the site into a maintenance mode during site provisioning. | `1` | `.env`, `scripts/vortex/provision.sh` |
| <a id="vortex_provision_verify_config_unchanged_after_update"></a>`VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE` | Verify that configuration was not changed by database updates. If enabled and config files are present, the provision will fail if database update hooks modify active configuration, preventing drush config:import from silently overwriting those changes. | `UNDEFINED` | `.env`, `scripts/vortex/provision.sh` |

@coderabbitai coderabbitai Bot Feb 18, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Search for the variable and its context in provision.sh
rg -n -C5 'VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE' scripts/vortex/provision.sh

Repository: drevops/vortex

Length of output: 1967

Update documentation: default value should be 0, not UNDEFINED.

Line 404 documents the default as UNDEFINED, but scripts/vortex/provision.sh line 45 sets the actual default to 0:

VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE="${VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE:-0}"

Update the table to reflect the concrete default value of 0.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.vortex/docs/content/development/variables.mdx at line 404, The docs
incorrectly list the default for the environment variable
VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE as UNDEFINED; update the
table entry to show the concrete default value 0 so it matches the runtime
default set by the provisioning script (the variable uses shell parameter
expansion to default to 0 when unset).

| <a id="vortex_purge_cache_acquia_skip"></a>`VORTEX_PURGE_CACHE_ACQUIA_SKIP` | Skip purging of edge cache in Acquia environment. | `UNDEFINED` | `ACQUIA ENVIRONMENT` |
| <a id="vortex_release_version_scheme"></a>`VORTEX_RELEASE_VERSION_SCHEME` | Versioning scheme used for releases.<br/><br/>Can be one of: calver, semver, other @see https://www.vortextemplate.com/docs/releasing | `calver` | `.env` |
| <a id="vortex_show_login"></a>`VORTEX_SHOW_LOGIN` | Show one-time login link. | `UNDEFINED` | `scripts/vortex/info.sh` |
Expand Down
8 changes: 6 additions & 2 deletions .vortex/docs/content/drupal/provision.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,13 +133,16 @@ section.
▼
🔄 Run DB updates
▼
⑦ 💡 Verify config unchanged? ──Config changed──► 🏁 EXIT 1 (fail) ✗
│ Config unchanged (or check disabled)
▼
⬇️ Import configuration (if config files present)
▼
🧹 Rebuild caches
▼
🔄 Run deployment hooks
▼
⑦ 😷 Run DB sanitization
⑧ 😷 Run DB sanitization
▼
⚙️ Run custom scripts
▼
Expand All @@ -158,7 +161,8 @@ You can control the provisioning flow using the following environment variables:
4. `VORTEX_PROVISION_FALLBACK_TO_PROFILE=1`<br/>Automatically fall back to installing from profile if the database dump file or container image is not available. Useful for distribution demos or when using recipes/profiles that can install without a pre-existing database.<br/><br/>
5. `VORTEX_PROVISION_POST_OPERATIONS_SKIP=1`<br/>Skip configuration imports, database updates, and other post-provisioning steps. Essentially, this is `drush sql:drop` and `$(drush sql:connect) < .data/db.sql` commands. This is useful when you want to provision a site without running any additional operations.<br/>`ahoy import-db` uses this flag to import DB and exit.<br/><br/>
6. `VORTEX_PROVISION_USE_MAINTENANCE_MODE=1`<br/>Enable maintenance mode right after the site is bootstrappable and disable it at the end. Useful when you want to prevent users from accessing the site while it is being provisioned.<br/><br/>
7. `VORTEX_PROVISION_SANITIZE_DB_SKIP=1`<br/>Disable database sanitization.
7. `VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE=1`<br/>Verify that active configuration was not changed by database updates. When enabled and config files are present, the provision will fail if `drush updatedb` modifies active configuration, preventing `drush config:import` from silently overwriting those changes.<br/><br/>
8. `VORTEX_PROVISION_SANITIZE_DB_SKIP=1`<br/>Disable database sanitization.

:::tip

Expand Down
6 changes: 6 additions & 0 deletions .vortex/installer/tests/Fixtures/handler_process/_baseline/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,12 @@ VORTEX_PROVISION_OVERRIDE_DB=0
# is not available.
VORTEX_PROVISION_FALLBACK_TO_PROFILE=0

# Verify that configuration was not changed by database updates.
# If enabled and config files are present, the provision will fail if
# database update hooks modify active configuration, preventing
# drush config:import from silently overwriting those changes.
VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE=0

# Skip database sanitization.
#
# Database sanitization is enabled by default in all non-production
Expand Down
4 changes: 2 additions & 2 deletions .vortex/installer/tests/Fixtures/handler_process/db_download_source_acquia/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -149,13 +149,8 @@
@@ -155,13 +155,8 @@
VORTEX_DB_FILE=db.sql

# Database download source.
Expand All @@ -13,7 +13,7 @@
# Environment to download the database from.
#
# Applies to hosting environments.
@@ -206,17 +201,3 @@
@@ -212,17 +207,3 @@
# with optional names in the format "email|name".
# Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"
VORTEX_NOTIFY_EMAIL_RECIPIENTS="webmaster@star-wars.com|Webmaster"
Expand Down
4 changes: 2 additions & 2 deletions .vortex/installer/tests/Fixtures/handler_process/db_download_source_container_registry/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -149,12 +149,11 @@
@@ -155,12 +155,11 @@
VORTEX_DB_FILE=db.sql

# Database download source.
Expand All @@ -15,7 +15,7 @@

# Environment to download the database from.
#
@@ -206,17 +205,3 @@
@@ -212,17 +211,3 @@
# with optional names in the format "email|name".
# Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"
VORTEX_NOTIFY_EMAIL_RECIPIENTS="webmaster@star-wars.com|Webmaster"
Expand Down
4 changes: 2 additions & 2 deletions .vortex/installer/tests/Fixtures/handler_process/db_download_source_ftp/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -149,13 +149,19 @@
@@ -155,13 +155,19 @@
VORTEX_DB_FILE=db.sql

# Database download source.
Expand All @@ -23,7 +23,7 @@
# Environment to download the database from.
#
# Applies to hosting environments.
@@ -206,17 +212,3 @@
@@ -212,17 +218,3 @@
# with optional names in the format "email|name".
# Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"
VORTEX_NOTIFY_EMAIL_RECIPIENTS="webmaster@star-wars.com|Webmaster"
Expand Down
4 changes: 2 additions & 2 deletions .vortex/installer/tests/Fixtures/handler_process/db_download_source_lagoon/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -149,13 +149,8 @@
@@ -155,13 +155,8 @@
VORTEX_DB_FILE=db.sql

# Database download source.
Expand All @@ -13,7 +13,7 @@
# Environment to download the database from.
#
# Applies to hosting environments.
@@ -206,17 +201,3 @@
@@ -212,17 +207,3 @@
# with optional names in the format "email|name".
# Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"
VORTEX_NOTIFY_EMAIL_RECIPIENTS="webmaster@star-wars.com|Webmaster"
Expand Down
4 changes: 2 additions & 2 deletions .vortex/installer/tests/Fixtures/handler_process/db_download_source_s3/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -149,13 +149,16 @@
@@ -155,13 +155,16 @@
VORTEX_DB_FILE=db.sql

# Database download source.
Expand All @@ -20,7 +20,7 @@
# Environment to download the database from.
#
# Applies to hosting environments.
@@ -206,17 +209,3 @@
@@ -212,17 +215,3 @@
# with optional names in the format "email|name".
# Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"
VORTEX_NOTIFY_EMAIL_RECIPIENTS="webmaster@star-wars.com|Webmaster"
Expand Down
2 changes: 1 addition & 1 deletion .vortex/installer/tests/Fixtures/handler_process/deploy_types_all_circleci/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -179,7 +179,7 @@
@@ -185,7 +185,7 @@

# Deployment occurs when tests pass in the CI environment.
# @see https://www.vortextemplate.com/docs/deployment
Expand Down
2 changes: 1 addition & 1 deletion .vortex/installer/tests/Fixtures/handler_process/deploy_types_all_gha/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -179,7 +179,7 @@
@@ -185,7 +185,7 @@

# Deployment occurs when tests pass in the CI environment.
# @see https://www.vortextemplate.com/docs/deployment
Expand Down
2 changes: 1 addition & 1 deletion .vortex/installer/tests/Fixtures/handler_process/deploy_types_artifact/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -179,7 +179,7 @@
@@ -185,7 +185,7 @@

# Deployment occurs when tests pass in the CI environment.
# @see https://www.vortextemplate.com/docs/deployment
Expand Down
2 changes: 1 addition & 1 deletion .vortex/installer/tests/Fixtures/handler_process/deploy_types_container_image/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -179,7 +179,7 @@
@@ -185,7 +185,7 @@

# Deployment occurs when tests pass in the CI environment.
# @see https://www.vortextemplate.com/docs/deployment
Expand Down
2 changes: 1 addition & 1 deletion .vortex/installer/tests/Fixtures/handler_process/deploy_types_lagoon/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -179,7 +179,7 @@
@@ -185,7 +185,7 @@

# Deployment occurs when tests pass in the CI environment.
# @see https://www.vortextemplate.com/docs/deployment
Expand Down
2 changes: 1 addition & 1 deletion .vortex/installer/tests/Fixtures/handler_process/deploy_types_none_circleci/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -174,14 +174,6 @@
@@ -180,14 +180,6 @@
VORTEX_RELEASE_VERSION_SCHEME=calver

################################################################################
Expand Down
2 changes: 1 addition & 1 deletion .vortex/installer/tests/Fixtures/handler_process/deploy_types_none_gha/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -174,14 +174,6 @@
@@ -180,14 +180,6 @@
VORTEX_RELEASE_VERSION_SCHEME=calver

################################################################################
Expand Down
Loading