feat: add displayAnnotations option to github-options (#8706)

Author: sheremet-va

docs/guide/reporters.md

@@ -564,6 +564,18 @@ export default defineConfig({
 })
 ```
 
+If you are using [Annotations API](/guide/test-annotations), the reporter will automatically inline them in the GitHub UI. You can disable this by setting `displayAnnotations` option to `false`:
+
+```ts
+export default defineConfig({
+  test: {
+    reporters: [
+      ['github-actions', { displayAnnotations: false }],
+    ],
+  },
+})
+```
+
 ### Blob Reporter
 
 Stores test results on the machine so they can be later merged using [`--merge-reports`](/guide/cli#merge-reports) command.

packages/vitest/src/node/reporters/github-actions.ts

@@ -10,6 +10,10 @@ import { capturePrintError } from '../printError'
 
 export interface GithubActionsReporterOptions {
   onWritePath?: (path: string) => string
+  /**
+   * @default true
+   */
+  displayAnnotations?: boolean
 }
 
 export class GithubActionsReporter implements Reporter {
@@ -25,7 +29,7 @@ export class GithubActionsReporter implements Reporter {
   }
 
   onTestCaseAnnotate(testCase: TestCase, annotation: TestAnnotation): void {
-    if (!annotation.location) {
+    if (!annotation.location || this.options.displayAnnotations === false) {
       return
     }
 

packages/vitest/src/node/reporters/index.ts

@@ -2,6 +2,7 @@ import type { Reporter, TestRunEndReason } from '../types/reporter'
 import type { BaseOptions, BaseReporter } from './base'
 import type { BlobOptions } from './blob'
 import type { DefaultReporterOptions } from './default'
+import type { GithubActionsReporterOptions } from './github-actions'
 import type { HTMLOptions } from './html'
 import type { JsonOptions } from './json'
 import type { JUnitOptions } from './junit'
@@ -71,6 +72,7 @@ export interface BuiltinReporterOptions {
   'junit': JUnitOptions
   'hanging-process': never
   'html': HTMLOptions
+  'github-actions': GithubActionsReporterOptions
 }
 
 export type { ReportedHookContext } from './reported-tasks'

test/core/vite.config.ts

@@ -95,7 +95,7 @@ export default defineConfig({
     },
     includeTaskLocation: true,
     reporters: process.env.GITHUB_ACTIONS
-      ? ['default', 'github-actions']
+      ? ['default', ['github-actions', { displayAnnotations: false }]]
       : [['default', { summary: true }], 'hanging-process'],
     testNamePattern: '^((?!does not include test that).)*$',
     coverage: {