How do I enable Xdebug in Pipelines?

This document describes how you can enable the Xdebug extension in Pipelines for PHP 8.3. With this, you can generate code coverage reports with PHPUnit.

To enable this extension:

1. Confirm that Xdebug is available in the PHP image:

   copy

   php -m | grep xdebug

2. Enable Xdebug temporarily as follows:

   copy

   php -d extension=xdebug.so -r "if (extension_loaded('xdebug')) { echo 'xdebug is loaded'; }"

3. Add the following command to the acquia-pipeline.yaml file before the test steps:

   copy

   version: 1.3.0 services: - php: version: 8.3 events: build: steps: - enable-xdebug: type: script script: - echo "Enabling Xdebug temporarily" - php -d extension=xdebug.so -v - ./vendor/bin/phpunit --coverage-text

   This method enables Xdebug for that specific execution. You cannot enable this extension in a persistent manner as that is supported only after you update the php.ini file, requiring access which is not supported in Pipelines.