Skip to content

Commit 49f2de1

Browse files
committed
Improve documentation for contents of junit-platform-console-standalone artifact
Closes #3648
1 parent 7ca15d9 commit 49f2de1

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

documentation/src/docs/asciidoc/user-guide/appendix.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ artifacts are deployed to Sonatype's {snapshot-repo}[snapshots repository] under
3535
Support for discovering and executing tests on the JUnit Platform from the console.
3636
See <<running-tests-console-launcher>> for details.
3737
`junit-platform-console-standalone`::
38-
An executable JAR with all dependencies included is provided in Maven Central under the
38+
An executable _Fat JAR_ that contains all dependencies is provided in Maven Central under the
3939
https://repo1.maven.org/maven2/org/junit/platform/junit-platform-console-standalone[junit-platform-console-standalone]
4040
directory. See <<running-tests-console-launcher>> for details.
4141
`junit-platform-engine`::

documentation/src/docs/asciidoc/user-guide/running-tests.adoc

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -621,13 +621,32 @@ The `{ConsoleLauncher}` is a command-line Java application that lets you launch
621621
Platform from the console. For example, it can be used to run JUnit Vintage and JUnit
622622
Jupiter tests and print test execution results to the console.
623623

624-
An executable `junit-platform-console-standalone-{platform-version}.jar` with all
625-
dependencies included is published in the {Maven_Central} repository under the
624+
An executable _Fat JAR_ (`junit-platform-console-standalone-{platform-version}.jar`) that
625+
contains the contents of all of its dependencies is published in the {Maven_Central}
626+
repository under the
626627
https://repo1.maven.org/maven2/org/junit/platform/junit-platform-console-standalone[junit-platform-console-standalone]
627-
directory. It includes the following dependencies:
628+
directory. It contains the contents of the following artifacts:
628629

629630
include::{standaloneConsoleLauncherShadowedArtifactsFile}[]
630631

632+
[NOTE]
633+
====
634+
Since the `junit-platform-console-standalone` JAR contains the contents of all of its
635+
dependencies, its Maven POM does not declare any dependencies.
636+
637+
Furthermore, it is not very likely that you would need to include a dependency on the
638+
`junit-platform-console-standalone` artifact in your project's Maven POM or Gradle build
639+
script. On the contrary, the executable `junit-platform-console-standalone` JAR is
640+
typically invoked directly from the command line or a shell script without a build script.
641+
642+
If you need to declare dependencies in your build script on some of the artifacts
643+
contained in the `junit-platform-console-standalone` artifact, you should declare
644+
dependencies only on the JUnit artifacts that are used in your project. To simplify
645+
dependency management of JUnit artifacts in your build, you may wish to use the
646+
`junit-jupiter` aggregator artifact or `junit-bom`. See <<dependency-metadata>> for
647+
details.
648+
====
649+
631650
You can https://docs.oracle.com/javase/tutorial/deployment/jar/run.html[run] the
632651
standalone `ConsoleLauncher` as shown below.
633652

0 commit comments

Comments
 (0)