docs: update

vitest-dev · Feb 9, 2024 · 9b45e7f · 9b45e7f
1 parent a42c8a0
commit 9b45e7f
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/docs/guide/reporters.md b/docs/guide/reporters.md
@@ -447,7 +447,17 @@ export default defineConfig({
 ### Github Actions Reporter <Badge type="info">1.3.0+</Badge>
 
 Output [workflow commands](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message)
-to provide annotations for test failures. This reporter is automatically enabled when `process.env.GITHUB_ACTIONS === 'true'`, thus it doesn't require any configuration.
+to provide annotations for test failures. This reporter is automatically enabled with a [`default`](#default-reporter) reporter when `process.env.GITHUB_ACTIONS === 'true'`.
+
+If you configure non-default reporters, you need to explicitly add `github-actions`.
+
+```ts
+export default defineConfig({
+  test: {
+    reporters: process.env.GITHUB_ACTIONS ? ['dot', 'github-actions'] : ['dot'],
+  },
+})
+```
 
 <img alt="Github Actions" img-dark src="https://github.com/vitest-dev/vitest/assets/4232207/336cddc2-df6b-4b8a-8e72-4d00010e37f5">
 <img alt="Github Actions" img-light src="https://github.com/vitest-dev/vitest/assets/4232207/ce8447c1-0eab-4fe1-abef-d0d322290dca">