docs: Warn about node-notifier caveat on windows systems. (#9454)

fixes #9452
jestjs · Jan 26, 2020 · 0845082 · 0845082
1 parent 03a7877
commit 0845082
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
 
 - `[@jest/reporters]` Remove unused dependencies and type exports ([#9462](https://github.com/facebook/jest/pull/9462))
 - `[website]` Update pictures of reports when matchers fail ([#9214](https://github.com/facebook/jest/pull/9214))
+- `[docs]` Warn about unexpected behavior / bug of node-notifier when using the `notify` options.
 
 ### Performance
 

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -506,6 +506,8 @@ Default: `false`
 
 Activates notifications for test results.
 
+**Beware:** Jest uses [node-notifier](https://github.com/mikaelbr/node-notifier) to display desktop notifications. On Windows, it creates a new start menu entry on the first use and not display the notification. Notifications will be properly displayed on subsequent runs
+
 ### `notifyMode` [string]
 
 Default: `failure-change`

diff --git a/website/versioned_docs/version-25.1/CLI.md b/website/versioned_docs/version-25.1/CLI.md
@@ -237,6 +237,8 @@ Disables stack trace in test results output.
 
 Activates notifications for test results. Good for when you don't want your consciousness to be able to focus on anything except JavaScript testing.
 
+**Beware:** Jest uses [node-notifier](https://github.com/mikaelbr/node-notifier) to display desktop notifications. On Windows, it creates a new start menu entry on the first use and not display the notification. Notifications will be properly displayed on subsequent runs
+
 ### `--onlyChanged`
 
 Alias: `-o`. Attempts to identify which tests to run based on which files have changed in the current repository. Only works if you're running tests in a git/hg repository at the moment and requires a static dependency graph (ie. no dynamic requires).