Skip to content

Commit 5f7df02

Browse files
committed
Build/Test Tools: Add inline docs to explain the PHPUnit strategy.
In [59587], the PHPUnit workflow strategy matrix was expanded using the criteria of “all LTS versions supported by WordPress with `>1%` usage according to WordPress.org/stats,” but this was only mentioned in the commit message. This adds some inline documentation to the explain that methodology for future reference. See #63170. git-svn-id: https://develop.svn.wordpress.org/trunk@60318 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 1db3088 commit 5f7df02

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

.github/workflows/phpunit-tests.yml

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ jobs:
5353
#
5454
# Creates a PHPUnit test job for each PHP/MySQL combination.
5555
#
56+
# Though MySQL 5.5 and 5.6 are still supported by WordPress, they are not currently tested here because the Docker
57+
# images do not work. Testing against MariaDB 5.5 provides a reasonable level of MySQL 5.5 testing (see MariaDB matrix
58+
# below for more details).
59+
#
5660
test-with-mysql:
5761
name: PHP ${{ matrix.php }}
5862
uses: ./.github/workflows/reusable-phpunit-tests-v3.yml
@@ -124,6 +128,10 @@ jobs:
124128
#
125129
# Creates a PHPUnit test job for each PHP/MariaDB combination.
126130
#
131+
# All LTS versions of MariaDB supported by WordPress with greater than 1% usage according to w.org/stats should be
132+
# tested. The exception to this rule is version 5.5. That release was intended as a drop-in replacement for MySQL.
133+
# Because the MySQL 5.5 Docker containers do not work, this ensures some level of MySQL 5.5 testing.
134+
#
127135
test-with-mariadb:
128136
name: PHP ${{ matrix.php }}
129137
uses: ./.github/workflows/reusable-phpunit-tests-v3.yml
@@ -168,11 +176,11 @@ jobs:
168176
#
169177
# Creates PHPUnit test jobs to test MariaDB and MySQL innovation releases.
170178
#
171-
# Though innovation releases are deemed "production grade" and never receive LTS status, they include new features
172-
# and updates that will be included in the next LTS version.
179+
# Though innovation releases are deemed "production grade", they never receive LTS status. However, they include new
180+
# features and updates that will be included in the next LTS version.
173181
#
174-
# Because upstream support for innovation releases gets dropped when a new one is released, only the most recent
175-
# innovation version is tested.
182+
# Because upstream support for innovation releases is dropped when a new one is released (including security updates),
183+
# only the most recent innovation version is tested.
176184
#
177185
test-innovation-releases:
178186
name: PHP ${{ matrix.php }}
@@ -217,6 +225,8 @@ jobs:
217225
#
218226
# Runs specific individual test groups.
219227
#
228+
# These tests are run against the most recent LTS version of MySQL.
229+
#
220230
specific-test-groups:
221231
name: ${{ matrix.phpunit-test-groups }}
222232
uses: ./.github/workflows/reusable-phpunit-tests-v3.yml

0 commit comments

Comments
 (0)