Add support for xdebug version based configuration

samlitowitz · samlitowitz · commit 24e1ee29dd21 · 2023-12-25T14:48:18.000-05:00
See "[[u]pgrading from Xdebug 2 to 3](https://xdebug.org/docs/upgrade_guide)" for more details
diff --git a/bin/generate.sh b/bin/generate.sh
@@ -39,9 +39,10 @@ for php_version in "${php_versions[@]}"; do
 
 		base_image="php:${php_version}-${php_suffix}"
 		xdebug_version="${xdebug_versions[${php_version}]}"
+		xdebug_major_version=`echo "${xdebug_version}" | sed 's/xdebug-\([1-9][0-9]\{0,\}\)\..*/\1/'`
 
 		mkdir -p "${target_dir}"
-		cp ./src/xdebug.ini "${target_dir}/xdebug.ini"
+		cp "./src/xdebug-${xdebug_major_version}.ini" "${target_dir}/xdebug.ini"
 
 		# shellcheck disable=SC2002
 		cat ./src/Dockerfile \
diff --git a/build/7.2-apache/Dockerfile b/build/7.2-apache/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-2.6.0 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/7.2-apache/xdebug.ini b/build/7.2-apache/xdebug.ini
@@ -10,4 +10,4 @@ xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
 xdebug.remote_enable=1
 xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.remote_port=9000
diff --git a/build/7.2-cli/Dockerfile b/build/7.2-cli/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-2.6.0 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/7.2-cli/xdebug.ini b/build/7.2-cli/xdebug.ini
@@ -10,4 +10,4 @@ xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
 xdebug.remote_enable=1
 xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.remote_port=9000
diff --git a/build/7.2-fpm/Dockerfile b/build/7.2-fpm/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-2.6.0 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/7.2-fpm/xdebug.ini b/build/7.2-fpm/xdebug.ini
@@ -10,4 +10,4 @@ xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
 xdebug.remote_enable=1
 xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.remote_port=9000
diff --git a/build/7.4-apache/Dockerfile b/build/7.4-apache/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-2.9.1 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/7.4-apache/xdebug.ini b/build/7.4-apache/xdebug.ini
@@ -10,4 +10,4 @@ xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
 xdebug.remote_enable=1
 xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.remote_port=9000
diff --git a/build/7.4-cli/Dockerfile b/build/7.4-cli/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-2.9.1 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/7.4-cli/xdebug.ini b/build/7.4-cli/xdebug.ini
@@ -10,4 +10,4 @@ xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
 xdebug.remote_enable=1
 xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.remote_port=9000
diff --git a/build/7.4-fpm/Dockerfile b/build/7.4-fpm/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-2.9.1 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/7.4-fpm/xdebug.ini b/build/7.4-fpm/xdebug.ini
@@ -10,4 +10,4 @@ xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
 xdebug.remote_enable=1
 xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.remote_port=9000
diff --git a/build/8.0-apache/Dockerfile b/build/8.0-apache/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.1.3 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.0-apache/xdebug.ini b/build/8.0-apache/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/build/8.0-cli/Dockerfile b/build/8.0-cli/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.1.3 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.0-cli/xdebug.ini b/build/8.0-cli/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/build/8.0-fpm/Dockerfile b/build/8.0-fpm/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.1.3 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.0-fpm/xdebug.ini b/build/8.0-fpm/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/build/8.1-apache/Dockerfile b/build/8.1-apache/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.1.3 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.1-apache/xdebug.ini b/build/8.1-apache/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/build/8.1-cli/Dockerfile b/build/8.1-cli/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.1.3 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.1-cli/xdebug.ini b/build/8.1-cli/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/build/8.1-fpm/Dockerfile b/build/8.1-fpm/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.1.3 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.1-fpm/xdebug.ini b/build/8.1-fpm/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/build/8.2-apache/Dockerfile b/build/8.2-apache/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.3.1 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.2-apache/xdebug.ini b/build/8.2-apache/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/build/8.2-cli/Dockerfile b/build/8.2-cli/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.3.1 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.2-cli/xdebug.ini b/build/8.2-cli/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/build/8.2-fpm/Dockerfile b/build/8.2-fpm/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install xdebug-3.3.1 \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/build/8.2-fpm/xdebug.ini b/build/8.2-fpm/xdebug.ini
@@ -2,12 +2,12 @@
 zend_extension=xdebug.so
 
 xdebug.cli_color=1
-xdebug.profiler_enable=0
-xdebug.profiler_enable_trigger=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
 
-xdebug.profiler_output_dir="/tmp"
+xdebug.output_dir="/tmp"
 xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
-xdebug.remote_enable=1
-xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.discover_client_host=true
+xdebug.client_port=9003
diff --git a/src/Dockerfile b/src/Dockerfile
@@ -16,4 +16,4 @@ RUN pecl channel-update pecl.php.net \
 	&& pecl install #XDEBUG_VERSION# \
 	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
diff --git a/src/xdebug-2.ini b/src/xdebug-2.ini
@@ -10,4 +10,4 @@ xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
 
 xdebug.remote_enable=1
 xdebug.remote_connect_back=1
-xdebug.remote_port=9000
+xdebug.remote_port=9000
diff --git a/src/xdebug-3.ini b/src/xdebug-3.ini
@@ -0,0 +1,13 @@
+[xdebug]
+zend_extension=xdebug.so
+
+xdebug.cli_color=1
+xdebug.mode=debug
+xdebug.start_with_request=trigger
+xdebug.trigger_value=StartXDebug
+
+xdebug.output_dir="/tmp"
+xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
+
+xdebug.discover_client_host=true
+xdebug.client_port=9003
