fix(core): improve GitHub Actions summaries (#1648)

9aoy · web-flow · commit ed4611cc9917 · 2026-07-29T19:00:57.000+08:00
diff --git a/e2e/reporter/fixtures-npm/package-lock.json b/e2e/reporter/fixtures-npm/package-lock.json
diff --git a/e2e/reporter/fixtures-npm/rstest.config.mts b/e2e/reporter/fixtures-npm/rstest.config.mts
@@ -0,0 +1,5 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  include: ['../fixtures/githubActions.test.ts'],
+});
diff --git a/e2e/reporter/fixtures/summaryTruncation.test.ts b/e2e/reporter/fixtures/summaryTruncation.test.ts
@@ -0,0 +1,19 @@
+import { expect, it } from '@rstest/core';
+
+it('reports a long diff', () => {
+  expect([
+    'received first line',
+    ...Array.from(
+      { length: 40 },
+      (_, index) => `received context line ${index}`,
+    ),
+    'received last line',
+  ]).toEqual([
+    'expected first line',
+    ...Array.from(
+      { length: 40 },
+      (_, index) => `expected context line ${index}`,
+    ),
+    'expected last line',
+  ]);
+});
diff --git a/e2e/reporter/githubActions.test.ts b/e2e/reporter/githubActions.test.ts
@@ -297,18 +297,17 @@ it.skipIf(!process.env.CI)(
       '.tmp',
       'github-step-summary-npm.md',
     );
-    const packageLockPath = join(__dirname, 'package-lock.json');
+    const npmFixturePath = join(__dirname, 'fixtures-npm');
 
     fs.rmSync(stepSummaryPath, { force: true });
-    fs.writeFileSync(packageLockPath, '{}');
 
     try {
       const { cli } = await runRstestCli({
         command: 'rstest',
-        args: ['run', 'githubActions', '--reporters', 'github-actions'],
+        args: ['run', '--reporters', 'github-actions'],
         options: {
           nodeOptions: {
-            cwd: __dirname,
+            cwd: npmFixturePath,
             env: {
               GITHUB_WORKSPACE: githubWorkspace,
               GITHUB_STEP_SUMMARY: stepSummaryPath,
@@ -324,10 +323,49 @@ it.skipIf(!process.env.CI)(
       const stepSummary = fs.readFileSync(stepSummaryPath, 'utf-8');
 
       expect(stepSummary).toContain(
-        "npx rstest 'fixtures/githubActions.test.ts' --testNamePattern 'should add two numbers correctly'",
+        "npx rstest '../fixtures/githubActions.test.ts' --testNamePattern 'should add two numbers correctly'",
       );
     } finally {
-      fs.rmSync(packageLockPath, { force: true });
+      fs.rmSync(stepSummaryPath, { force: true });
+      fs.rmSync(join(__dirname, '.tmp'), { recursive: true, force: true });
+    }
+  },
+);
+
+it.skipIf(!process.env.CI)(
+  'github-actions summary supports a custom field length',
+  async () => {
+    const stepSummaryPath = join(
+      __dirname,
+      '.tmp',
+      'github-step-summary-long-diff.md',
+    );
+    fs.rmSync(stepSummaryPath, { force: true });
+
+    try {
+      const { cli } = await runRstestCli({
+        command: 'rstest',
+        args: ['run', '-c', './rstest.githubActions.longSummary.config.mts'],
+        options: {
+          nodeOptions: {
+            cwd: __dirname,
+            env: {
+              GITHUB_WORKSPACE: githubWorkspace,
+              GITHUB_STEP_SUMMARY: stepSummaryPath,
+            },
+          },
+        },
+      });
+
+      await cli.exec;
+      await cli.waitForStreamsEnd();
+      expect(cli.exec.process?.exitCode).toBe(1);
+
+      const stepSummary = fs.readFileSync(stepSummaryPath, 'utf-8');
+
+      expect(stepSummary).toContain('-   "expected first line",');
+      expect(stepSummary).toContain('+   "received last line",');
+    } finally {
       fs.rmSync(stepSummaryPath, { force: true });
       fs.rmSync(join(__dirname, '.tmp'), { recursive: true, force: true });
     }
diff --git a/e2e/reporter/rstest.githubActions.longSummary.config.mts b/e2e/reporter/rstest.githubActions.longSummary.config.mts
@@ -0,0 +1,15 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  include: ['**/fixtures/summaryTruncation.test.ts'],
+  reporters: [
+    [
+      'github-actions',
+      {
+        summary: {
+          maxCharsPerField: 10_000,
+        },
+      },
+    ],
+  ],
+});
diff --git a/packages/core/src/reporter/githubActions.ts b/packages/core/src/reporter/githubActions.ts
@@ -5,6 +5,7 @@ import stripAnsi from 'strip-ansi';
 import type {
   Duration,
   GetSourcemap,
+  ReporterWithOptions,
   SnapshotSummary,
   TestFileResult,
   TestResult,
@@ -38,6 +39,7 @@ export class GithubActionsReporter {
   private readonly stepSummaryPath?: string;
   private readonly enableAnnotations: boolean;
   private readonly enableSummary: boolean;
+  private readonly summaryMaxCharsPerField: number;
   private readonly reportName?: string;
 
   constructor({
@@ -49,18 +51,24 @@ export class GithubActionsReporter {
     config?: {
       name?: string;
     };
-    options: {
+    options: ReporterWithOptions<'github-actions'>[1] & {
       // `createReporters` never supplies this; only tests do. Optional is the truth.
       onWritePath?: (path: string) => string;
-      annotations?: boolean;
-      summary?: boolean;
     };
   }) {
     this.onWritePath = options.onWritePath;
     this.rootPath = rootPath;
     this.stepSummaryPath = process.env.GITHUB_STEP_SUMMARY;
     this.enableAnnotations = options.annotations !== false;
     this.enableSummary = options.summary !== false;
+    this.summaryMaxCharsPerField =
+      typeof options.summary === 'object'
+        ? Math.max(
+            0,
+            options.summary.maxCharsPerField ??
+              STEP_SUMMARY_DEFAULT_MAX_CHARS_PER_FIELD,
+          )
+        : STEP_SUMMARY_DEFAULT_MAX_CHARS_PER_FIELD;
     this.reportName = config?.name;
   }
 
@@ -162,6 +170,7 @@ export class GithubActionsReporter {
           failures,
           getSourcemap,
           unhandledErrors,
+          maxCharsPerField: this.summaryMaxCharsPerField,
         }),
       );
     }
@@ -179,7 +188,7 @@ function escapeData(s: string): string {
 
 const STEP_SUMMARY_MAX_FAILURES = 20;
 const STEP_SUMMARY_MAX_FLAKY_TESTS = 20;
-const STEP_SUMMARY_MAX_MESSAGE_LENGTH = 400;
+const STEP_SUMMARY_DEFAULT_MAX_CHARS_PER_FIELD = 400;
 const STEP_SUMMARY_MAX_FLAKY_MESSAGE_LENGTH = 160;
 const ROOT_PATH_PLACEHOLDER = '<ROOT>';
 const DEFAULT_PROJECT_NAME = 'rstest';
@@ -274,6 +283,7 @@ async function renderStepSummary({
   failures,
   getSourcemap,
   unhandledErrors,
+  maxCharsPerField,
 }: {
   results: TestFileResult[];
   testResults: TestResult[];
@@ -283,6 +293,7 @@ async function renderStepSummary({
   failures: FailureItem[];
   getSourcemap: GetSourcemap;
   unhandledErrors?: Error[];
+  maxCharsPerField: number;
 }): Promise<string> {
   const { parseErrorStacktrace } = await import('../utils/error');
   const packageManagerAgent = await detectPackageManagerAgent(rootPath);
@@ -365,12 +376,19 @@ async function renderStepSummary({
 
       pushHeading(lines, 3, `❌ FAIL Unhandled Error ${index + 1}`);
       lines.push(
-        `**${error.name || 'Error'}**: ${trimForSummary(error.message)}`,
+        `**${error.name || 'Error'}**: ${trimForSummary(
+          error.message,
+          maxCharsPerField,
+        )}`,
       );
       lines.push('');
 
       if (error.stack) {
-        pushFencedBlock(lines, '', stripAnsi(trimForSummary(error.stack)));
+        pushFencedBlock(
+          lines,
+          '',
+          stripAnsi(trimForSummary(error.stack, maxCharsPerField)),
+        );
       }
     }
 
@@ -398,15 +416,19 @@ async function renderStepSummary({
         ? errors
         : [{ message: 'Unknown error' }]) {
         const errorType = getErrorType(error);
-        const message = trimForSummary(error.message);
+        const message = trimForSummary(error.message, maxCharsPerField);
         const retryLabel = getRetryErrorLabel(error);
         lines.push(
           `**${retryLabel ? `${retryLabel} - ` : ''}${errorType}**: ${message}`,
         );
         lines.push('');
 
         if (error.diff) {
-          pushFencedBlock(lines, 'diff', stripAnsi(trimForSummary(error.diff)));
+          pushFencedBlock(
+            lines,
+            'diff',
+            stripAnsi(trimForSummary(error.diff, maxCharsPerField)),
+          );
         }
 
         if (error.stack) {
@@ -449,12 +471,16 @@ async function renderStepSummary({
   return `${lines.join('\n')}\n`;
 }
 
-function trimForSummary(input: string): string {
-  if (input.length <= STEP_SUMMARY_MAX_MESSAGE_LENGTH) {
+function trimForSummary(input: string, maxChars: number): string {
+  if (input.length <= maxChars) {
     return input;
   }
 
-  return `${input.slice(0, STEP_SUMMARY_MAX_MESSAGE_LENGTH - 1)}…`;
+  if (maxChars === 0) {
+    return '';
+  }
+
+  return `${input.slice(0, maxChars - 1)}…`;
 }
 
 function collectFlakyTests(testResults: TestResult[]): TestResult[] {
diff --git a/packages/core/src/types/reporter.ts b/packages/core/src/types/reporter.ts
@@ -150,10 +150,22 @@ type GithubActionsReporterOptions = {
    */
   annotations?: boolean;
   /**
-   * Whether to append a Markdown summary to `GITHUB_STEP_SUMMARY`.
+   * Markdown summary controls.
+   * - `false`: do not append a summary to `GITHUB_STEP_SUMMARY`
+   * - `true`: append a summary with default limits
+   * - object form: append a summary with customized limits
    * @default true
    */
-  summary?: boolean;
+  summary?:
+    | boolean
+    | {
+        /**
+         * Maximum characters for each failure message and diff, and each
+         * unhandled error message and stack.
+         * @default 400
+         */
+        maxCharsPerField?: number;
+      };
 };
 
 export type BlobReporterOptions = {
diff --git a/packages/core/tests/reporter/githubActions.test.ts b/packages/core/tests/reporter/githubActions.test.ts
@@ -214,6 +214,110 @@ describe('GithubActionsReporter step summary', () => {
     }
   });
 
+  it('uses the configured summary field length without changing the default', async () => {
+    const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'rstest-gha-'));
+    const summaryPath = path.join(tempDir, 'summary.md');
+    const defaultSummaryPath = path.join(tempDir, 'default-summary.md');
+    const previousSummaryPath = process.env.GITHUB_STEP_SUMMARY;
+    const previousWorkspacePath = process.env.GITHUB_WORKSPACE;
+    const testPath = path.join(tempDir, 'tests/long-diff.test.ts');
+    const diff = [
+      '- Expected',
+      '+ Received',
+      '',
+      '- expected first line',
+      ...Array.from(
+        { length: 40 },
+        (_, index) => `  unchanged context line ${index}`,
+      ),
+      '+ received last line',
+    ].join('\n');
+
+    process.env.GITHUB_STEP_SUMMARY = summaryPath;
+    process.env.GITHUB_WORKSPACE = tempDir;
+
+    try {
+      const reporter = new GithubActionsReporter({
+        rootPath: tempDir,
+        options: {
+          onWritePath: (value) => value,
+          annotations: false,
+          summary: {
+            maxCharsPerField: 2_000,
+          },
+        },
+      });
+
+      const runEndPayload: Parameters<
+        GithubActionsReporter['onTestRunEnd']
+      >[0] = {
+        results: [
+          {
+            testId: 'file-1',
+            status: 'fail',
+            name: 'long-diff.test.ts',
+            testPath,
+            project: 'rstest',
+            results: [],
+          },
+        ],
+        testResults: [
+          {
+            testId: 'test-1',
+            status: 'fail',
+            name: 'shows the useful diff',
+            parentNames: [],
+            testPath,
+            project: 'rstest',
+            errors: [
+              {
+                name: 'AssertionError',
+                message: 'values differ',
+                diff,
+              },
+            ],
+          },
+        ],
+        duration: emptyDuration,
+        snapshotSummary: emptySnapshotSummary,
+        getSourcemap: async () => null,
+      };
+
+      await reporter.onTestRunEnd(runEndPayload);
+
+      process.env.GITHUB_STEP_SUMMARY = defaultSummaryPath;
+      const defaultReporter = new GithubActionsReporter({
+        rootPath: tempDir,
+        options: {
+          onWritePath: (value) => value,
+          annotations: false,
+        },
+      });
+      await defaultReporter.onTestRunEnd(runEndPayload);
+
+      const summary = await fs.readFile(summaryPath, 'utf-8');
+      const defaultSummary = await fs.readFile(defaultSummaryPath, 'utf-8');
+      expect(summary).toContain('- expected first line');
+      expect(summary).toContain('+ received last line');
+      expect(defaultSummary).toContain('- expected first line');
+      expect(defaultSummary).not.toContain('+ received last line');
+    } finally {
+      if (previousSummaryPath === undefined) {
+        delete process.env.GITHUB_STEP_SUMMARY;
+      } else {
+        process.env.GITHUB_STEP_SUMMARY = previousSummaryPath;
+      }
+
+      if (previousWorkspacePath === undefined) {
+        delete process.env.GITHUB_WORKSPACE;
+      } else {
+        process.env.GITHUB_WORKSPACE = previousWorkspacePath;
+      }
+
+      await fs.rm(tempDir, { recursive: true, force: true });
+    }
+  });
+
   it('renders flaky tests with a short summary of previous failures', async () => {
     const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'rstest-gha-'));
     const summaryPath = path.join(tempDir, 'summary.md');
diff --git a/website/docs/en/guide/basic/reporters.mdx b/website/docs/en/guide/basic/reporters.mdx
diff --git a/website/docs/zh/guide/basic/reporters.mdx b/website/docs/zh/guide/basic/reporters.mdx
