Skip to content

Commit 58bb342

Browse files
committed
test_runner: mark module as stable
Fixes: #46642
1 parent db81af6 commit 58bb342

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

doc/api/cli.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1394,6 +1394,9 @@ added:
13941394
- v18.1.0
13951395
- v16.17.0
13961396
changes:
1397+
- version: REPLACEME
1398+
pr-url: https://github.com/nodejs/node/pull/46983
1399+
description: The test runner is now stable.
13971400
- version:
13981401
- v19.2.0
13991402
- v18.13.0
@@ -1410,6 +1413,10 @@ for more details.
14101413

14111414
<!-- YAML
14121415
added: v18.11.0
1416+
changes:
1417+
- version: REPLACEME
1418+
pr-url: https://github.com/nodejs/node/pull/46983
1419+
description: The test runner is now stable.
14131420
-->
14141421

14151422
A regular expression that configures the test runner to only execute tests
@@ -1420,6 +1427,10 @@ whose name matches the provided pattern. See the documentation on
14201427

14211428
<!-- YAML
14221429
added: v19.6.0
1430+
changes:
1431+
- version: REPLACEME
1432+
pr-url: https://github.com/nodejs/node/pull/46983
1433+
description: The test runner is now stable.
14231434
-->
14241435

14251436
A test reporter to use when running tests. See the documentation on
@@ -1429,6 +1440,10 @@ A test reporter to use when running tests. See the documentation on
14291440

14301441
<!-- YAML
14311442
added: v19.6.0
1443+
changes:
1444+
- version: REPLACEME
1445+
pr-url: https://github.com/nodejs/node/pull/46983
1446+
description: The test runner is now stable.
14321447
-->
14331448

14341449
The destination for the corresponding test reporter. See the documentation on
@@ -1440,6 +1455,10 @@ The destination for the corresponding test reporter. See the documentation on
14401455
added:
14411456
- v18.0.0
14421457
- v16.17.0
1458+
changes:
1459+
- version: REPLACEME
1460+
pr-url: https://github.com/nodejs/node/pull/46983
1461+
description: The test runner is now stable.
14431462
-->
14441463

14451464
Configures the test runner to only execute top level tests that have the `only`

doc/api/test.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@
66
added:
77
- v18.0.0
88
- v16.17.0
9+
changes:
10+
- version: REPLACEME
11+
pr-url: https://github.com/nodejs/node/pull/46983
12+
description: The test runner is now stable.
913
-->
1014

11-
> Stability: 1 - Experimental
15+
> Stability: 2 - Stable
1216
1317
<!-- source_link=lib/test.js -->
1418

@@ -377,6 +381,8 @@ internally.
377381

378382
## Collecting code coverage
379383

384+
> Stability: 1 - Experimental
385+
380386
When Node.js is started with the [`--experimental-test-coverage`][]
381387
command-line flag, code coverage is collected and statistics are reported once
382388
all tests have completed. If the [`NODE_V8_COVERAGE`][] environment variable is
@@ -531,6 +537,11 @@ The following built-reporters are supported:
531537
where each passing test is represented by a `.`,
532538
and each failing test is represented by a `X`.
533539

540+
The exact output of these reporters is subject to change between versions of
541+
Node.js, and should not be relied on programmatically. If programmatic access
542+
to the test runner's output is required, use the events emitted by the
543+
{TestsStream}.
544+
534545
### Custom reporters
535546

536547
[`--test-reporter`][] can be used to specify a path to custom reporter.

0 commit comments

Comments
 (0)