From 7db7e1b19ac14bc4230305da7ed38a53ad0c9bfc Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Wed, 20 May 2020 09:24:42 +0200 Subject: [PATCH] DATACMNS-1730 - Update releasetrain reference documentation with spring-data-bom artifact. --- src/main/asciidoc/dependencies.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/main/asciidoc/dependencies.adoc b/src/main/asciidoc/dependencies.adoc index 52992a005..ef0bed2c8 100644 --- a/src/main/asciidoc/dependencies.adoc +++ b/src/main/asciidoc/dependencies.adoc @@ -11,7 +11,7 @@ Due to the different inception dates of individual Spring Data modules, most of org.springframework.data - spring-data-releasetrain + spring-data-bom {releasetrainVersion} import pom @@ -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 `` 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 <> 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 <> you would like to use. [[dependencies.spring-framework]] == Spring Framework