Spring/spring-data-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATACMNS-1730 - Update releasetrain reference documentation with spring-data-bom artifact.

Browse Source
This commit is contained in:
Mark Paluch
2020-05-20 09:24:42 +02:00
parent 4be5aae181
commit 7db7e1b19a
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/main/asciidoc/dependencies.adoc
View File

@@ -11,7 +11,7 @@ Due to the different inception dates of individual Spring Data modules, most of
<dependencies>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-releasetrain</artifactId>
<artifactId>spring-data-bom</artifactId>
<version>{releasetrainVersion}</version>
<scope>import</scope>
<type>pom</type>
@@ -22,13 +22,13 @@ Due to the different inception dates of individual Spring Data modules, most of
====
[[dependencies.train-names]]
The current release train version is `{releasetrainVersion}`. The train names ascend alphabetically and the currently available trains are listed https://github.com/spring-projects/spring-data-commons/wiki/Release-planning[here]. The version name follows the following pattern: `${name}-${release}`, where release can be one of the following:
[[dependencies.train-version]]
The current release train version is `{releasetrainVersion}`. The train version uses https://calver.org/[calver] with the pattern `YYYY.MINOR.MICRO`.
The version name follows `${calver}` for GA releases and service releases and the following pattern for all other versions: `${calver}-${modifier}`, where `modifier` can be one of the following:
* `BUILD-SNAPSHOT`: Current snapshots
* `SNAPSHOT`: Current snapshots
* `M1`, `M2`, and so on: Milestones
* `RC1`, `RC2`, and so on: Release candidates
* `RELEASE`: GA release
* `SR1`, `SR2`, and so on: Service releases
A working example of using the BOMs can be found in our https://github.com/spring-projects/spring-data-examples/tree/master/bom[Spring Data examples repository]. With that in place, you can declare the Spring Data modules you would like to use without a version in the `<dependencies />` block, as follows:
@@ -48,7 +48,7 @@ A working example of using the BOMs can be found in our https://github.com/sprin
[[dependencies.spring-boot]]
== Dependency Management with Spring Boot
Spring Boot selects a recent version of Spring Data modules for you. If you still want to upgrade to a newer version, configure the property `spring-data-releasetrain.version` to the <<dependencies.train-names,train name and iteration>> you would like to use.
Spring Boot selects a recent version of Spring Data modules for you. If you still want to upgrade to a newer version, configure the property `spring-data-releasetrain.version` to the <<dependencies.train-version,train version and iteration>> you would like to use.
[[dependencies.spring-framework]]
== Spring Framework