Feat/file report (#174)

Author: Ma11hewThomas

.github/workflows/build-and-test.yaml

@@ -42,6 +42,7 @@ jobs:
         with:
           report-path: './ctrf/*.json'
           pull-request-report: true
+          annotate: false
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: always()
@@ -300,6 +301,25 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: always()
+  file-reports-test:
+    needs: build-and-test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: npm install
+      - name: Modify reports
+        run: npm run modify-reports
+      - name: File Reports Test
+        uses: ./
+        with:
+          report-path: './ctrf-reports/*.json'
+          file-report: true
+          annotate: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: always()
   npx-cli-test:
     runs-on: ubuntu-latest
     needs: build-and-test
@@ -313,4 +333,4 @@ jobs:
       - name: Modify reports
         run: npm run modify-reports
       - name: Default tables
-        run: node dist/core/cli.js ctrf-reports/ctrf-report.json --title "Default tables" --annotate false
+        run: node dist/core/cli.js ctrf-reports/ctrf-report.json --title "Default tables" --annotate false

README.md

@@ -140,6 +140,7 @@ There are several inputs available
     skipped-report: false
     suite-folded-report: false
     suite-list-report: false
+    file-report: false
     pull-request-report: false
     commit-report: false
     custom-report: false
@@ -157,13 +158,13 @@ There are several inputs available
     on-fail-only: false # Add a pull request comment only if tests fail. Default is false
     exit-on-fail: false # Exit the workflow with a failure status if any tests fail. Default is false
     use-suite-name: false # Prefix test names with the suite name for better grouping. Default is false
+    collapse-large-reports: false # Collapse large reports (test-table and test-list) for better readability. Default is false
     update-comment: false # Update existing Pull Request comment. Default is false
     overwrite-comment: false # Overwrite existing Pull Request comment. Default is false
     always-latest-comment: false # Create a new comment if the existing comment is not the latest in the thread. Default is false
     comment-tag: false # Tag to match Pull Request comment
     write-ctrf-to-file: 'ctrf/ctrf-report.json' # Path to write the internal processed CTRF report for future processing. Default no write
     upload-artifact: true # Upload to workflow artifact the processed CTRF report for future processing. Default false
-    comment-tag: '' # Tag to match Pull Request comment
 
     # Advanced Options
     artifact-name: 'ctrf-report' # Name of the artifact containing test reports. Default is ctrf-report

__tests__/ctrf/report-preparation.test.ts

@@ -574,6 +574,7 @@ function createSingleReportInputs(): Inputs {
     customReport: false,
     insightsReport: false,
     slowestReport: false,
+    fileReport: false,
     communityReport: false,
     communityReportName: '',
     artifactName: '',

action.yml

@@ -78,6 +78,10 @@ inputs:
     description: 'Include the suite list report.'
     required: false
     default: false
+  file-report:
+    description: 'Include the file report showing tests grouped by file path.'
+    required: false
+    default: false
   insights-report:
     description:
       'Include the insights report showing test metrics and statistics.'

badges/coverage.svg

@@ -95,4 +95,4 @@
       }
     ]
   }
-}
+}