Update User Guide, API documentation overview, and Release Notes

sormuras · sormuras · commit 6c5ca167f0b6 · 2025-11-04T12:18:32.000+01:00
diff --git a/documentation/src/docs/asciidoc/link-attributes.adoc b/documentation/src/docs/asciidoc/link-attributes.adoc
@@ -230,6 +230,8 @@ endif::[]
 // Jupiter Migration Support
 :EnableJUnit4MigrationSupport:               {javadoc-root}/org.junit.jupiter.migrationsupport/org/junit/jupiter/migrationsupport/EnableJUnit4MigrationSupport.html[@EnableJUnit4MigrationSupport]
 :EnableRuleMigrationSupport:                 {javadoc-root}/org.junit.jupiter.migrationsupport/org/junit/jupiter/migrationsupport/rules/EnableRuleMigrationSupport.html[@EnableRuleMigrationSupport]
+// JUnit Start
+:JUnit:                                      {javadoc-root}/org.junit.start/org/junit/start/JUnit.html[JUnit]
 // Vintage
 :junit-vintage-engine:                       {javadoc-root}/org.junit.vintage.engine/org/junit/vintage/engine/package-summary.html[junit-vintage-engine]
 // Examples Repository
@@ -247,6 +249,8 @@ endif::[]
 :Checkstyle:                                 https://checkstyle.sourceforge.io[Checkstyle]
 :DiscussionsQA:                              https://github.com/junit-team/junit-framework/discussions/categories/q-a[Q&A category on GitHub Discussions]
 :Hamcrest:                                   https://hamcrest.org/JavaHamcrest/[Hamcrest]
+:JEP511:                                     https://openjdk.org/jeps/511[JEP 511]
+:JEP512:                                     https://openjdk.org/jeps/512[JEP 512]
 :Jimfs:                                      https://google.github.io/jimfs/[Jimfs]
 :Log4j:                                      https://logging.apache.org/log4j/2.x/[Log4j]
 :Log4j_JDK_Logging_Adapter:                  https://logging.apache.org/log4j/2.x/log4j-jul/index.html[Log4j JDK Logging Adapter]
diff --git a/documentation/src/docs/asciidoc/release-notes/release-notes-6.1.0-M1.adoc b/documentation/src/docs/asciidoc/release-notes/release-notes-6.1.0-M1.adoc
@@ -52,6 +52,17 @@ repository on GitHub.
 [[release-notes-6.1.0-M1-junit-jupiter-new-features-and-improvements]]
 ==== New Features and Improvements
 
+* Introduce new module `org.junit.start` for writing and running tests. It simplifies
+  usages of JUnit in compact source files together with a single module import statement:
+[source,java,indent=0]
+----
+import module org.junit.start;
+
+void main() { JUnit.run(); }
+
+@Test
+void test() { Assertions.assertEquals(2, 1 + 1); }
+----
 * Introduce new `dynamicTest(Consumer<? super Configuration>)` factory method for dynamic
   tests. It allows configuring the `ExecutionMode` of the dynamic test in addition to its
   display name, test source URI, and executable.
diff --git a/documentation/src/docs/asciidoc/user-guide/running-tests.adoc b/documentation/src/docs/asciidoc/user-guide/running-tests.adoc
@@ -836,6 +836,40 @@ DYNAMIC = 35
 REPORTED = 37
 ----
 
+[[running-tests-source-launcher]]
+=== Source Launcher
+
+Java 25 introduced Module Import Declarations with {JEP511} and Compact Source Files
+and Instance Methods with {JEP512}. The `org.junit.start` module is JUnit's "On-Ramp"
+enabler, allowing to write minimal source code programs. For example, like in a
+`HelloTests.java` file reading:
+
+```java
+import module org.junit.start;
+
+void main() {
+  JUnit.run();
+}
+
+@Test
+void stringLength() {
+  Assertions.assertEquals(11, "Hello JUnit".length());
+}
+```
+With all required modular JAR files available in a local `lib/` directory, the
+following Java 25+ command will discover and execute tests using the JUnit Platform.
+It will also print the result tree to the console.
+
+```shell
+java --module-path lib --add-modules org.junit.start HelloTests.java
+╷
+└─ JUnit Jupiter ✔
+   └─ HelloTests ✔
+      └─ stringLength() ✔
+```
+
+Find JUnit's class API documentation here: {JUnit}
+
 [[running-tests-discovery-selectors]]
 === Discovery Selectors
 
diff --git a/documentation/src/javadoc/junit-overview.html b/documentation/src/javadoc/junit-overview.html
@@ -1,6 +1,6 @@
 <body>
 
-<p>This document consists of three sections:</p>
+<p>This document consists of four sections:</p>
 
 <dl>
     <dt>Platform</dt>
@@ -12,13 +12,16 @@
     </dd>
     <dt>Jupiter</dt>
     <dd>JUnit Jupiter is the combination of the programming model and extension model for
-        writing JUnit tests and extensions. The Jupiter sub-project provides a TestEngine
+        writing JUnit tests and extensions. The Jupiter subproject provides a TestEngine
         for running Jupiter based tests on the platform.
     </dd>
     <dt>Vintage</dt>
     <dd>JUnit Vintage provides a TestEngine for running JUnit 3 and JUnit 4 based tests on the
         platform.
     </dd>
+    <dt>Other Modules</dt>
+    <dd>This section lists all modules that are not part of a dedicated section.
+    </dd>
 </dl>
 
 <p>Already consulted the <a href="../user-guide/index.html">JUnit User Guide</a>?</p>
