Skip to content

Commit 7c47a63

Browse files
committed
Document BOM support in Release Notes and User Guide
1 parent 9f197e9 commit 7c47a63

File tree

4 files changed

+24
-1
lines changed

4 files changed

+24
-1
lines changed

documentation/documentation.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ asciidoctor {
105105
attributes 'jupiter-version': project.property('version'),
106106
'platform-version': project.property('platformVersion'),
107107
'vintage-version': project.property('vintageVersion'),
108+
'bom-version': project.property('version'),
108109
'junit4-version': project.property('junit4Version'),
109110
'apiguardian-version': project.property('apiGuardianVersion'),
110111
'ota4j-version': project.property('ota4jVersion'),

documentation/src/docs/asciidoc/release-notes/release-notes-5.2.0-M1.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ link:{junit5-repo}+/milestone/22?closed=1+[5.2 M1] milestone page in the JUnit r
1010
on GitHub.
1111

1212

13+
[[release-notes-5.2.0-M1-overall-improvements]]
14+
=== Overall Improvements
15+
16+
* JUnit BOM: To ease dependency management using
17+
https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Importing_Dependencies[Maven]
18+
or https://docs.gradle.org/current/userguide/managing_transitive_dependencies.html#sec:bom_import[Gradle],
19+
a Bill of Materials POM is now provided under the `org.junit:junit-bom:5.2.0-M1` Maven
20+
coordinates.
21+
22+
1323
[[release-notes-5.2.0-M1-junit-platform]]
1424
=== JUnit Platform
1525

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,18 @@ Snapshot artifacts are deployed to Sonatype's {snapshot-repo}[snapshots reposito
122122
JUnit Vintage test engine implementation that allows to run vintage JUnit tests, i.e. tests
123123
written in the JUnit 3 or JUnit 4 style, on the new JUnit Platform.
124124

125+
[[dependency-metadata-junit-bom]]
126+
==== Bill of Materials (BOM)
127+
128+
The Bill of Materials POM provided under the following Maven coordinates can be used to
129+
ease dependency management when referencing multiple of the above artifacts using
130+
https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Importing_Dependencies[Maven]
131+
or https://docs.gradle.org/current/userguide/managing_transitive_dependencies.html#sec:bom_import[Gradle].
132+
133+
* *Group ID*: `org.junit`
134+
* *Artifact ID*: `junit-bom`
135+
* *Version*: `{bom-version}`
136+
125137
[[dependency-metadata-dependencies]]
126138
==== Dependencies
127139

junit-bom/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ using Maven [1] or Gradle [2]. Please refer to the JUnit 5 User Guide [3] for
55
details.
66

77
[1] https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Importing_Dependencies
8-
[2] https://docs.gradle.org/4.6-rc-1/userguide/managing_transitive_dependencies.html#sec:bom_import
8+
[2] https://docs.gradle.org/current/userguide/managing_transitive_dependencies.html#sec:bom_import
99
[3] https://junit.org/junit5/docs/current/user-guide/#dependency-metadata-junit-bom

0 commit comments

Comments
 (0)