Build/Test Tools: Document every matrix exclusion.

There should be inline documentation anytime a strategy matrix has an `exclude` combination configured so that contributors have proper context as to why it’s there. See #62221. git-svn-id: https://develop.svn.wordpress.org/trunk@59531 602fd350-edb4-49c9-b593-d223f7449a82
AKJUS · Dec 17, 2024 · c697356 · c697356
1 parent 8ed4cae
commit c697356
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 5 deletions.
diff --git a/.github/workflows/install-testing.yml b/.github/workflows/install-testing.yml
@@ -78,15 +78,19 @@ jobs:
 
         # Exclude some PHP and MySQL versions that cannot currently be tested with Docker containers.
         exclude:
+          # There are no local WordPress Docker environment containers for PHP <= 5.3.
           - php: '5.2'
           - php: '5.3'
+          # MySQL containers <= 5.5 do not exist or fail to start properly.
           - db-version: '5.0'
           - db-version: '5.1'
           - db-version: '5.5'
+          # The PHP <= 7.3/MySQL 8.4 jobs currently fail due to mysql_native_password being disabled by default. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '8.4'
           - php: '7.3'
             db-version: '8.4'
+          # MySQL 9.0+ will not work on PHP 7.2 & 7.3. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '9.0'
           - php: '7.3'

diff --git a/.github/workflows/local-docker-environment.yml b/.github/workflows/local-docker-environment.yml
@@ -88,9 +88,9 @@ jobs:
         db-version: ${{ fromJSON( needs.build-test-matrix.outputs.mysql-versions ) }}
 
         exclude:
-          # The MySQL 5.5 containers will not start.
+          # MySQL containers <= 5.5 do not exist or fail to start properly.
           - db-version: '5.5'
-          # MySQL 9.0+ will not work on PHP 7.2 & 7.3
+          # MySQL 9.0+ will not work on PHP 7.2 & 7.3. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '9.0'
           - php: '7.3'

diff --git a/.github/workflows/phpunit-tests.yml b/.github/workflows/phpunit-tests.yml
@@ -93,7 +93,7 @@ jobs:
             report: true
 
         exclude:
-          # MySQL 9.0+ will not work on PHP 7.2 & 7.3
+          # MySQL 9.0+ will not work on PHP 7.2 & 7.3. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '9.0'
           - php: '7.3'

diff --git a/.github/workflows/upgrade-testing.yml b/.github/workflows/upgrade-testing.yml
@@ -72,11 +72,12 @@ jobs:
         multisite: [ false, true ]
 
         exclude:
+          # The PHP <= 7.3/MySQL 8.4 jobs currently fail due to mysql_native_password being disabled by default. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '8.4'
           - php: '7.3'
             db-version: '8.4'
-          # MySQL 9.0+ will not work on PHP 7.2 & 7.3
+          # MySQL 9.0+ will not work on PHP 7.2 & 7.3. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '9.1'
           - php: '7.3'
@@ -108,6 +109,7 @@ jobs:
         multisite: [ false, true ]
 
         exclude:
+          # The PHP <= 7.3/MySQL 8.4 jobs currently fail due to mysql_native_password being disabled by default. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '8.4'
           - php: '7.3'
@@ -137,6 +139,7 @@ jobs:
         multisite: [ false, true ]
 
         exclude:
+          # The PHP <= 7.3/MySQL 8.4 jobs currently fail due to mysql_native_password being disabled by default. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '8.4'
           - php: '7.3'
@@ -195,6 +198,7 @@ jobs:
         multisite: [ false, true ]
 
         exclude:
+          # The PHP <= 7.3/MySQL 8.4 jobs currently fail due to mysql_native_password being disabled by default. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '8.4'
           - php: '7.3'
@@ -254,11 +258,12 @@ jobs:
         multisite: [ false, true ]
 
         exclude:
+          # The PHP <= 7.3/MySQL 8.4 jobs currently fail due to mysql_native_password being disabled by default. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '8.4'
           - php: '7.3'
             db-version: '8.4'
-          # MySQL 9.0+ will not work on PHP 7.2 & 7.3
+          # MySQL 9.0+ will not work on PHP 7.2 & 7.3. See https://core.trac.wordpress.org/ticket/61218.
           - php: '7.2'
             db-version: '9.1'
           - php: '7.3'