chore: Update reporter configuration property name #17

estruyf · Aug 7, 2024 · 51f3098 · 51f3098
1 parent 0b6d355
commit 51f3098
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -38,7 +38,7 @@ The reporter supports the following configuration options:
 | showAnnotations | Show annotations from tests | `true` |
 | showTags | Show tags from tests | `true` |
 | showError | Show error message in summary | `false` |
-| report | Define which types of test results should be shown in the summary | `['pass', 'skipped', 'fail', 'flaky']` |
+| includeResults | Define which types of test results should be shown in the summary | `['pass', 'skipped', 'fail', 'flaky']` |
 | quiet | Do not show any output in the console | `false` |
 
 To use these option, you can update the reporter configuration:

diff --git a/playwright.config.ts b/playwright.config.ts
@@ -20,7 +20,7 @@ const config: PlaywrightTestConfig<{}, {}> = {
         useDetails: false,
         showError: true,
         quiet: false,
-        report: ["fail", "flaky", "skipped"],
+        includeResults: ["fail", "flaky", "skipped"],
       },
     ],
     [
@@ -30,7 +30,7 @@ const config: PlaywrightTestConfig<{}, {}> = {
         useDetails: false,
         showError: true,
         quiet: false,
-        report: ["pass", "skipped"],
+        includeResults: ["pass", "skipped"],
       },
     ],
     [
@@ -39,7 +39,7 @@ const config: PlaywrightTestConfig<{}, {}> = {
         title: "Reporter (details: true, report: fail, flaky, skipped)",
         useDetails: true,
         quiet: true,
-        report: ["fail", "flaky", "skipped"],
+        includeResults: ["fail", "flaky", "skipped"],
       },
     ],
   ],

diff --git a/src/index.ts b/src/index.ts
@@ -31,8 +31,8 @@ class GitHubAction implements Reporter {
       this.options.showTags = true;
     }
 
-    if (typeof options.report === "undefined") {
-      this.options.report = ["fail", "flaky", "pass", "skipped"];
+    if (typeof options.includeResults === "undefined") {
+      this.options.includeResults = ["fail", "flaky", "pass", "skipped"];
     }
 
     if (process.env.NODE_ENV === "development") {

diff --git a/src/models/GitHubActionOptions.ts b/src/models/GitHubActionOptions.ts
@@ -7,5 +7,5 @@ export interface GitHubActionOptions {
   showTags: boolean;
   showError?: boolean;
   quiet?: boolean;
-  report?: DisplayLevel[];
+  includeResults?: DisplayLevel[];
 }
diff --git a/src/utils/processResults.ts b/src/utils/processResults.ts
@@ -56,7 +56,7 @@ export const processResults = async (
             options.showAnnotations,
             options.showTags,
             !!options.showError,
-            options.report as DisplayLevel[]
+            options.includeResults as DisplayLevel[]
           );
 
           if (!content) {
@@ -76,7 +76,7 @@ export const processResults = async (
             options.showAnnotations,
             options.showTags,
             !!options.showError,
-            options.report as DisplayLevel[]
+            options.includeResults as DisplayLevel[]
           );
 
           if (tableRows.length !== 0) {