Merge branch 'release/25.1.1'

drevops · Jan 20, 2025 · 0f3dbad · 0f3dbad · github-actions · Jan 20, 2025
2 parents 04b46ac + 019a204
commit 0f3dbad
Show file tree

Hide file tree

Showing 21 changed files with 317 additions and 211 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -39,7 +39,7 @@ aliases:
   #;< SCAFFOLD_DEV
   - &renovatebot_git_author 'Renovate Self Hosted <[email protected]>'
   #;> SCAFFOLD_DEV
-  ##### - &renovatebot_git_author 'RenovateBot Self Hosted <renovatebot@your-site-url.example>'
+  ##### - &renovatebot_git_author 'RenovateBot Self Hosted <renovatebot@your-site-domain.example>'
   # The schedule to run RenovateBot on. Defaults to running twice a day.
   - &renovatebot_schedule "5 11,23 * * *"
   #;> RENOVATEBOT

diff --git a/.env b/.env
@@ -27,7 +27,7 @@
 # the project directory and can be overridden with $COMPOSE_PROJECT_NAME.
 VORTEX_PROJECT=your_site
 
-# Name of the webroot directory with Drupal codebase.
+# Name of the web root directory containing a Drupal codebase.
 VORTEX_WEBROOT=web
 
 # The timezone for the containers.
@@ -43,11 +43,13 @@ DRUPAL_PROFILE=standard
 # Drupal theme name.
 DRUPAL_THEME=your_site_theme
 
-# Stage file proxy origin. Note that HTTP Auth provided by Shield will be
-# automatically added to the origin URL.
-DRUPAL_STAGE_FILE_PROXY_ORIGIN=https://www.your-site-url.example/
+# Stage file proxy origin.
+#
+# If using Shield, the HTTP authentication credentials will be automatically
+# added to the origin URL.
+DRUPAL_STAGE_FILE_PROXY_ORIGIN=https://www.your-site-domain.example/
 
-# Shield print message.
+# Shield message.
 DRUPAL_SHIELD_PRINT="Restricted access."
 
 #;< REDIS
@@ -71,13 +73,16 @@ DRUPAL_CLAMAV_MODE=daemon
 #                                 PROVISION                                    #
 ################################################################################
 
-# Variables in this section control how the site is provisioned.
+# By "provision", we mean the process of initialising the database (from dump
+# or fresh install from profile), running updates, appying configuration
+# changes, clearing caches and performing other tasks that prepare the site for
+# use.
 # @see https://vortex.drevops.com/workflows/provision
 
 # Set to 1 to install a site from profile instead of the database file dump.
 VORTEX_PROVISION_USE_PROFILE=0
 
-# Overwrite existing database if it exists.
+# Overwrite a database if it exists.
 #
 # Usually set to 0 in deployed environments and can be temporary set to 1 for
 # a specific deployment.
@@ -90,23 +95,42 @@ VORTEX_PROVISION_OVERRIDE_DB=0
 # environments and is always skipped in the production environment.
 VORTEX_PROVISION_SANITIZE_DB_SKIP=0
 
-# Sanitization email pattern. Sanitization is enabled by default in all
-# non-production environments.
+# Sanitization email pattern.
+#
+# Applied if database sanitization is enabled.
 # @see https://vortex.drevops.com/workflows/build#sanitization
-VORTEX_PROVISION_SANITIZE_DB_EMAIL="user_%uid@your-site-url.example"
+VORTEX_PROVISION_SANITIZE_DB_EMAIL="user_%uid@your-site-domain.example"
 
 # Put the site into a maintenance mode during site provisioning.
 VORTEX_PROVISION_USE_MAINTENANCE_MODE=1
 
+################################################################################
+#                                HOSTING                                       #
+################################################################################
+
+#;< LAGOON
+# Lagoon project name. May be different from $VORTEX_PROJECT.
+LAGOON_PROJECT=your_site
+
+# Dedicated branch to identify the production environment.
+VORTEX_LAGOON_PRODUCTION_BRANCH=main
+#;> LAGOON
+
+#;< ACQUIA
+# Acquia application name.
+VORTEX_ACQUIA_APP_NAME=
+#;> ACQUIA
+
 ################################################################################
 #                                DATABASE                                      #
 ################################################################################
 
 # Database service runs a single database within a container.
-# See settings.php for database credentials defaults.
+# See settings.php for database credentials defaults or run
+# `ahoy drush sql:connect`.
 
-# Database can be imported from a file dump into an empty database started from
-# the database default image or can exist in a pre-built container image.
+# Database can be imported from a *file dump* into an empty database started
+# from the database default image or can *exist* in a pre-built container image.
 # Defaults to importing from a file.
 # @see https://vortex.drevops.com/workflows/database
 
@@ -124,26 +148,28 @@ VORTEX_DB_FILE=db.sql
 #;< !PROVISION_USE_PROFILE
 # Database can be sourced from one of the following locations:
 #
-# - `curl` - directly from URL as a file using CURL.
-# - `ftp` - directly from FTP as a file using CURL.
+# - `curl` - directly from a URL as a file using CURL.
+# - `ftp` - directly from an FTP as a file using CURL.
 # - `acquia` - from the latest Acquia backup via Cloud API as a file.
 # - `lagoon` - from Lagoon main environment as a file.
 # - `container_registry` - from the container registry as a container image.
 # - `none` - not downloaded, site is freshly installed for every build.
-
+#
 # Note that "container_registry" works only for database-in-image
 # database storage (when $VORTEX_DB_IMAGE variable has a value).
 VORTEX_DB_DOWNLOAD_SOURCE=curl
 
 #;< VORTEX_DB_DOWNLOAD_SOURCE_CURL
-# Database dump file sourced from CURL, with optional HTTP Basic Authentication
-# credentials embedded into the value.
+# Database dump file sourced from CURL.
+#
+# HTTP Basic Authentication credentials should be embedded into the value.
 VORTEX_DB_DOWNLOAD_CURL_URL=
 #;> VORTEX_DB_DOWNLOAD_SOURCE_CURL
 
 # Environment to download the database from.
+#
+# Applies to Acquia and Lagoon environments.
 VORTEX_DB_DOWNLOAD_ENVIRONMENT=prod
-#;> !PROVISION_USE_PROFILE
 
 #;< FTP
 # Database dump file sourced from FTP.
@@ -159,17 +185,11 @@ VORTEX_DB_DOWNLOAD_FTP_FILE=db.sql
 #;> FTP
 
 #;< ACQUIA
-# Acquia application name to download the database from.
-VORTEX_ACQUIA_APP_NAME=
-
 # Acquia database name to download the database from.
 VORTEX_DB_DOWNLOAD_ACQUIA_DB_NAME=your_site
 #;> ACQUIA
 
-#;< LAGOON
-# Lagoon project name. May be different from $VORTEX_PROJECT.
-LAGOON_PROJECT=your_site
-#;> LAGOON
+#;> !PROVISION_USE_PROFILE
 
 #;< DEPLOYMENT
 ################################################################################
@@ -186,12 +206,6 @@ LAGOON_PROJECT=your_site
 #
 # See https://vortex.drevops.com/workflows/deploy
 VORTEX_DEPLOY_TYPES=artifact
-
-#;< LAGOON
-# Dedicated branch to identify the production environment.
-VORTEX_LAGOON_PRODUCTION_BRANCH=main
-#;> LAGOON
-
 #;> DEPLOYMENT
 
 #;< NOTIFICATIONS
@@ -208,30 +222,26 @@ VORTEX_LAGOON_PRODUCTION_BRANCH=main
 VORTEX_NOTIFY_CHANNELS=email
 
 # Email to send notifications from.
-VORTEX_NOTIFY_EMAIL_FROM="webmaster@your-site-url.example"
+VORTEX_NOTIFY_EMAIL_FROM="webmaster@your-site-domain.example"
 
 # Email address(es) to send notifications to.
 #
 # Multiple names can be specified as a comma-separated list of email addresses
 # with optional names in the format "email|name".
 # Example: "[email protected]|Jane Doe, [email protected]|John Doe"
-VORTEX_NOTIFY_EMAIL_RECIPIENTS="webmaster@your-site-url.example"
+VORTEX_NOTIFY_EMAIL_RECIPIENTS="webmaster@your-site-domain.example"
 #;> NOTIFICATIONS
 
 #;< DEMO
 ################################################################################
 #                                  DEMO                                        #
 ################################################################################
-
-#-------------------------------------------------------------------------------
-# Variables used to override project-specific values for demonstration purposes.
-#
-# This is to allow to demonstrate how Vortex works without asking users
-# to perform any additional steps when trying out Vortex for the first time.
-#
-# Remove this section from your project when database download integration setup
-# is finished.
-#-------------------------------------------------------------------------------
+#                                                                              #
+# Override project-specific values for demonstration purposes.                 #
+# Used to showcase Vortex without asking users to perform additional steps.    #
+# Remove this section after completing database download integration.          #
+#                                                                              #
+################################################################################
 
 #;< VORTEX_DB_DOWNLOAD_SOURCE_CURL
 # URL of the demo database used for demonstration with CURL database
@@ -240,7 +250,7 @@ VORTEX_DB_DOWNLOAD_CURL_URL=https://github.com/drevops/vortex/releases/download/
 #;> VORTEX_DB_DOWNLOAD_SOURCE_CURL
 
 #;< VORTEX_DB_IMAGE
-# The name of the demo database image used for demonstration only for
+# The name of the demo database image used for demonstration for
 # database-in-image data storage.
 #; The line below will be automatically uncommented for database-in-image
 #; storage. It is commented out to allow running non-database-in-image

diff --git a/.github/workflows/renovate.yml b/.github/workflows/renovate.yml
@@ -25,4 +25,4 @@ jobs:
           RENOVATE_DEPENDENCY_DASHBOARD_TITLE: 'Renovate Dependency Dashboard (self-hosted) by GitHub Actions'
           RENOVATE_DEPENDENCY_DASHBOARD: ${{ vars.RENOVATE_DEPENDENCY_DASHBOARD || 'false' }}
           RENOVATE_DRY_RUN: ${{ vars.RENOVATE_DRY_RUN || 'false' }}
-          RENOVATE_GIT_AUTHOR: ${{ vars.RENOVATE_GIT_AUTHOR || 'Renovate Self Hosted <renovatebot@your-site-url.example>' }}
+          RENOVATE_GIT_AUTHOR: ${{ vars.RENOVATE_GIT_AUTHOR || 'Renovate Self Hosted <renovatebot@your-site-domain.example>' }}
diff --git a/.lagoon.yml b/.lagoon.yml
@@ -109,10 +109,10 @@ environments:
     # By default, Lagoon installs Let's Encrypt certificates for all environments.
     # routes:
     #   - nginx-php:
-    #       - www.your-site-url.example:
+    #       - www.your-site-domain.example:
     #           tls-acme: 'false'
     monitoring_urls:
-      - www.your-site-url.example
+      - www.your-site-domain.example
   # Branch name that represents development environment.
   develop:
     cronjobs:
@@ -124,10 +124,10 @@ environments:
     # By default, Lagoon installs Let's Encrypt certificates for all environments.
     # routes:
     #   - nginx-php:
-    #       - dev.your-site-url.example:
+    #       - dev.your-site-domain.example:
     #           tls-acme: 'false'
     monitoring_urls:
-      - dev.your-site-url.example
+      - dev.your-site-domain.example
 
 routes:
   insecure: Redirect
diff --git a/.vortex/.ahoy.yml b/.vortex/.ahoy.yml
@@ -8,7 +8,7 @@ commands:
     cmd: |
       [ ! -d ./tests/node_modules ] && npm --prefix tests ci
       [ ! -d ./docs/node_modules ] && npm --prefix docs ci
-      [ ! -d ./installer/node_modules ] && composer --working-dir installer install
+      [ ! -d ./installer/vendor ] && composer --working-dir installer install
 
   docs:
     name: Start documentation server.
@@ -28,6 +28,12 @@ commands:
       [ ! -d ./docs/node_modules ] && npm --prefix docs ci
       npm --prefix docs run build
 
+  build-installer:
+    name: Build documentation.
+    cmd: |
+      [ ! -d ./installer/vendor ] && composer --working-dir installer install
+      composer --working-dir installer build
+
   lint:
     name: Lint Vortex project.
     cmd: |

diff --git a/.vortex/docs/.utils/variables/extra/.env.variables.sh b/.vortex/docs/.utils/variables/extra/.env.variables.sh
@@ -16,7 +16,7 @@ VORTEX_DB_IMAGE=
 VORTEX_DB_IMAGE_BASE=
 
 # Drupal admin email. May need to be reset if database was sanitized.
-DRUPAL_ADMIN_EMAIL="webmaster@your-site-url.example"
+DRUPAL_ADMIN_EMAIL="webmaster@your-site-domain.example"
 
 # Password replacement used for sanitised database.
 VORTEX_PROVISION_SANITIZE_DB_PASSWORD="<RANDOM STRING>"
@@ -42,7 +42,7 @@ DRUPAL_SITE_NAME="${VORTEX_PROJECT}"
 
 # Drupal site email.
 # Used only when installing from profile.
-DRUPAL_SITE_EMAIL="webmaster@your-site-url.example"
+DRUPAL_SITE_EMAIL="webmaster@your-site-domain.example"
 
 # Print output from Composer install.
 VORTEX_COMPOSER_VERBOSE=1

diff --git a/.vortex/docs/.utils/variables/extra/ci.variables.sh b/.vortex/docs/.utils/variables/extra/ci.variables.sh
@@ -65,4 +65,4 @@ RENOVATE_DEPENDENCY_DASHBOARD=false
 RENOVATE_DRY_RUN=false
 
 # Commit author for self-hosted Renovate bot.
-RENOVATE_GIT_AUTHOR='Renovate Self Hosted <renovatebot@your-site-url.example>'
+RENOVATE_GIT_AUTHOR='Renovate Self Hosted <renovatebot@your-site-domain.example>'
diff --git a/.vortex/docs/content/getting-started/features.mdx b/.vortex/docs/content/getting-started/features.mdx
@@ -10,7 +10,7 @@ The following list includes ✅ completed  and 🚧 upcoming features.
 
 * 💧 Drupal
     * ✅ Based on [drupal-composer/drupal-project](https://github.com/drupal-composer/drupal-project)
-    * ✅ [Drupal 10](https://www.drupal.org/project/drupal)
+    * ✅ [Drupal 11](https://www.drupal.org/project/drupal)
     * ✅ Configurable webroot
     * ✅ [Pre-configured settings](https://github.com/drevops/vortex/blob/develop/web/sites/default/settings.php)
     * ✅ [Custom module scaffold](https://github.com/drevops/vortex/blob/develop/web/modules/custom/ys_core)