Changeset 57570 for trunk/.github/workflows/test-coverage.yml

Timestamp:

02/08/2024 07:30:26 PM (2 years ago)

Author:

desrosj

Message:

Build/Test Tools: Generate a human-readable HTML coverage report.

This updates the test coverage GitHub Actions workflow to generate a human-readable HTML report in addition to the current machine readable one submitted to Codecov.

Props jorbin.
Fixes #60476.

File:

• trunk/.github/workflows/test-coverage.yml (modified) (5 diffs)

trunk/.github/workflows/test-coverage.yml

@@ -58 +58 @@
   # - Upload the multisite code coverage report to Codecov.io.
   test-coverage-report:
-    name: ${{ matrix.multisite && 'Multisite' || 'Single site' }} report
+    name: ${{ matrix.multisite && 'Multisite' || 'Single site' }} report (${{ matrix.format }})
     runs-on: ubuntu-latest
     permissions:
@@ -68 +68 @@
       matrix:
         multisite: [ false, true ]
+        format: [ clover, html ]
 
     steps:
@@ -145 +146 @@
       - name: Run tests as a single site
         if: ${{ ! matrix.multisite }}
-        run: npm run test:php -- --verbose -c phpunit.xml.dist --coverage-clover wp-code-coverage-single-clover-${{ github.sha }}.xml
+        run: npm run test:php -- --verbose -c phpunit.xml.dist --coverage-${{ 'html' == matrix.format && 'html' || 'clover' }} wp-code-coverage-single-${{ github.sha }}${{ 'clover' == matrix.format && '.xml' || '' }}
 
       - name: Ensure version-controlled files are not modified during the tests
@@ -155 +156 @@
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          file: wp-code-coverage-single-clover-${{ github.sha }}.xml
+          file: wp-code-coverage-single-${{ github.sha }}${{ 'clover' == matrix.format && '.xml' || '' }}
           flags: single,php
           fail_ci_if_error: true
 
+      - name: Upload single site HTML report as artifact
+        if: ${{ ! matrix.multisite && matrix.format == 'html' }}
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
+        with:
+          name: wp-code-coverage-single-${{ github.sha }}
+          path: wp-code-coverage-single-${{ github.sha }}
+          overwrite: true
+
       - name: Run tests as a multisite install
         if: ${{ matrix.multisite }}
-        run: npm run test:php -- --verbose -c tests/phpunit/multisite.xml --coverage-clover wp-code-coverage-multisite-clover-${{ github.sha }}.xml
+        run: npm run test:php -- --verbose -c tests/phpunit/multisite.xml --coverage-${{ 'html' == matrix.format && 'html' || 'clover' }} wp-code-coverage-multisite-${{ github.sha }}${{ 'clover' == matrix.format && '.xml' || '' }}
 
       - name: Ensure version-controlled files are not modified during the tests
@@ -171 +180 @@
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          file: wp-code-coverage-multisite-clover-${{ github.sha }}.xml
+          file: wp-code-coverage-multisite-${{ github.sha }}${{ 'clover' == matrix.format && '.xml' || '' }}
           flags: multisite,php
           fail_ci_if_error: true
+
+      - name: Upload multisite HTML report as artifact
+        if: ${{ matrix.multisite && matrix.format == 'html' }}
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
+        with:
+          name: wp-code-coverage-multisite-${{ github.sha }}
+          path: wp-code-coverage-multisite-${{ github.sha }}
+          overwrite: true
 
   slack-notifications: