Skip to content

Commit 7c93d80

Browse files
committed
Polish release notes for 5.7 RC1
1 parent a15f93f commit 7c93d80

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

documentation/src/docs/asciidoc/release-notes/release-notes-5.7.0-RC1.adoc

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
* Java 16 support
1313
* Configurable default method orderer
1414
* Custom disabled reasons for all `@Enabled*`/`@Disabled*` annotations
15-
* Improvements to `assertTimeoutPreemptively`
15+
* Improvements to `assertTimeoutPreemptively()`
1616
* Improvements to `@CsvFileSource` and `@CsvSource`
1717

1818
For a complete list of all _closed_ issues and pull requests for this release, consult the
19-
link:{junit5-repo}+/milestone/49?closed=1+[5.7 M2] milestone page in the JUnit repository
19+
link:{junit5-repo}+/milestone/49?closed=1+[5.7 RC1] milestone page in the JUnit repository
2020
on GitHub.
2121

2222

@@ -32,16 +32,18 @@ on GitHub.
3232

3333
==== Promoted Features
3434

35-
* The following APIs have been promoted from "experimental":
36-
- `LauncherConstants` is now "stable"
37-
- `LauncherConfig` (except for methods introduced in 5.7) is now "stable"
38-
- `LegacyXmlReportGeneratingListener` is now "stable"
39-
- `org.junit.platform.testkit.engine` is now "maintained"
35+
* The following APIs have been promoted from "experimental" status:
36+
- `LauncherConstants` is now _stable_
37+
- `LauncherConfig` (except for methods introduced in 5.7) is now _stable_
38+
- `LegacyXmlReportGeneratingListener` is now _stable_
39+
- `org.junit.platform.testkit.engine` is now _maintained_
4040

4141
==== Bug Fixes
4242

43-
* Characters in exception messages and other user-supplied values that are not allowed in
44-
XML are now replaced with their character reference – for example, `\0` becomes `�`.
43+
* In XML reports generated by the `ConsoleLauncher` or
44+
`LegacyXmlReportGeneratingListener`, characters in exception messages and other
45+
user-supplied values that are not allowed in XML are now replaced with their character
46+
reference – for example, `\0` becomes `�`.
4547
* The `Launcher` now throws an exception when a previously executed `TestPlan` is
4648
attempted to be executed again.
4749

@@ -54,21 +56,20 @@ on GitHub.
5456

5557
==== New Features and Improvements
5658

57-
* When using `ConsoleLauncher`, explicitly selected classes from `--select-class` and
59+
* When using the `ConsoleLauncher`, classes selected explicitly via `--select-class` and
5860
`--select-method` are now always executed regardless of class name patterns provided
59-
with `--include-classname` or the default class name pattern.
61+
via `--include-classname` or the default class name pattern.
6062
* The `ConsoleLauncher` now honors the `--disable-ansi-colors` option when printing usage
6163
help.
6264
* New `FilePosition` support in `FileSelector` and `ClasspathResourceSelector`.
63-
* Custom `PostDiscoveryFilter` implementations can now be registered via Java’s
64-
`ServiceLoader` mechanism.
6565
* New `getJavaClass()` and `getJavaMethod()` methods in
6666
`org.junit.platform.engine.support.descriptor.MethodSource`.
67-
* New module `org.junit.platform.jfr` added. When running on Java 11 or later, it
68-
provides and registers a `TestExecutionListener` that generates Java Flight Recorder
69-
events.
70-
* `ExecutionRecorder` in junit-platform-testkit is now public for fine-grained testing of
71-
classes that use `EngineExecutionListener`.
67+
* Custom `PostDiscoveryFilter` implementations can now be registered via Java’s
68+
`ServiceLoader` mechanism.
69+
* New `org.junit.platform.jfr` module. When running on Java 11 or later, it provides and
70+
registers a `TestExecutionListener` that generates Java Flight Recorder events.
71+
* The `ExecutionRecorder` in `junit-platform-testkit` is now public for fine-grained
72+
testing of classes that use `EngineExecutionListener`.
7273
* `ForkJoinPoolHierarchicalTestExecutorService` can now be constructed by supplying a
7374
`ParallelExecutionConfiguration`.
7475
* `HierarchicalTestEngine` now supports a global resource lock.
@@ -79,7 +80,7 @@ on GitHub.
7980

8081
==== Promoted Features
8182

82-
* The following APIs have been promoted from "experimental" to "stable":
83+
* The following APIs have been promoted from _experimental_ to _stable_:
8384
- `junit-jupiter-migrationsupport`
8485
- `junit-jupiter-params` (i.e. `@ParameterizedTest` etc.)
8586
- `@TestMethodOrder`, `MethodOrderer`, and its pre-5.7 implementations
@@ -93,13 +94,13 @@ on GitHub.
9394

9495
==== Bug Fixes
9596

97+
* Inherited `@BeforeEach` methods are now executed on correct instances for `@Nested`
98+
classes.
9699
* Registered `TestInstancePreDestroyCallback` extensions are now always called if an
97100
instance of a test class was created, regardless whether any registered
98101
`TestInstancePostProcessor` extension threw an exception.
99102
* Disabled `@TestTemplate` methods (e.g. `@ParameterizedTest` and `@RepeatedTest` methods)
100103
are now reported to registered `TestWatcher` extensions.
101-
* Inherited `@BeforeEach` methods are now executed on correct instances for `@Nested`
102-
classes.
103104

104105
==== Deprecations and Breaking Changes
105106

@@ -115,7 +116,7 @@ on GitHub.
115116
* `assertTimeoutPreemptively()` now uses threads with a specific name, conveying their use
116117
by the framework, to facilitate debugging and stack trace analysis.
117118
* All `@Enabled*`/`@Disabled*` annotations now have an optional `disabledReason` attribute
118-
that can be used to provide and additional explanation as to why a test or container
119+
that can be used to provide an additional explanation as to why a test or container
119120
might be disabled.
120121
* `JAVA_16` has been added to the `JRE` enum for use with JRE-based execution conditions.
121122
* New `MethodOrderer.MethodName` to replace `MethodOrderer.Alphanumeric` with the exact
@@ -126,16 +127,16 @@ on GitHub.
126127
`Iterator` for the input source.
127128
* `@CsvFileSource` now allows one to specify file paths as an alternative to classpath
128129
resources.
129-
* `@CsvFileSource` and `@CsvSource` now provide a `maxCharsPerColumn` attribute
130-
for configuring the maximum number of characters per column.
131-
* Arguments in display names of parameterized test invocations are now truncated if
132-
they exceed a configurable maximum length (defaults to 512 characters).
130+
* `@CsvFileSource` and `@CsvSource` now provide a `maxCharsPerColumn` attribute for
131+
configuring the maximum number of characters per column.
132+
* Arguments in display names of parameterized test invocations are now truncated if they
133+
exceed a configurable maximum length (defaults to 512 characters).
134+
* New `@Isolated` annotation allows to run test classes in isolation of other test classes
135+
when using parallel test execution.
133136
* New `TypedArgumentConverter` for converting one specific type to another, therefore
134137
reducing boilerplate type checks compared to implementing `ArgumentConverter` directly.
135138
* New `ExtensionContext.getConfigurationParameter(String, Function<String, T>)`
136139
convenience method for reading transformed configuration parameters from extensions.
137-
* New `@Isolated` annotation allows to run test classes in isolation of other test classes
138-
when using parallel test execution.
139140

140141

141142
[[release-notes-5.7.0-RC1-junit-vintage]]

0 commit comments

Comments
 (0)