Changeset 53552 for trunk/.env

Timestamp:

06/21/2022 11:45:19 PM (2 years ago)

Author:

desrosj

Message:

Build/Test Tools: Configure Xdebug modes in the local Docker environment.

One change in the update from Xdebug version 2.x to 3.x was a shift from enabling features to switching into modes.

When the version of Xdebug installed in the PHP 7.4 Docker container was updated from 2.x to 3.x, the code coverage reporting workflow stopped generating reports due to a lack of available coverage drivers.

This change adds the XDEBUG_MODE environment variable to the local Docker environment configuration to allow the active modes to be changed. This environment variable takes precedence over the xdebug.mode setting, but will not change the value of the xdebug.mode setting.

The LOCAL_PHP_XDEBUG_MODE environment variable has been added to the .env file and can be used to change the modes enabled in the Docker container. The code coverage reporting workflow uses this variable to enable the coverage mode, which is required for generating a test coverage report.

By default, debug and `debug modes are active, which enables the more commonly used features of Xdebug: development helpers and step debugging.

Props afragen, johnbillion, desrosj.
Fixes #56022.

File:

• trunk/.env (modified) (1 diff)

trunk/.env

@@ -18 +18 @@
 LOCAL_PHP=latest
 
-# Whether or not to enable XDebug.
+# Whether or not to enable Xdebug.
 LOCAL_PHP_XDEBUG=false
+
+##
+# The Xdebug features to enable.
+#
+# By default, the following features are enabled in the local environment:
+# - Development helpers (`develop`).
+# - Step debugging (`debug`).
+#
+# To generate a code coverage report, `coverage` mode must be active.
+#
+# For a full list of accepted values, see https://xdebug.org/docs/all_settings#mode.
+##
+LOCAL_PHP_XDEBUG_MODE=develop,debug
 
 # Whether or not to enable Memcached.