From cdbe6fa1224b66af01bad241db77da82a062ac66 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Thu, 19 Jul 2018 17:57:42 +0200 Subject: [PATCH] Document properties migrator usage Closes gh-13600 --- .../src/main/asciidoc/getting-started.adoc | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc index 62bffbcab9c..5c2ae0b32a2 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc @@ -451,6 +451,26 @@ that provides detailed upgrade instructions. Check also the {github-wiki}["`release notes`"] for a list of "`new and noteworthy`" features for each release. +When upgrading to a new feature release, some properties may have been renamed or removed. +Spring Boot provides a way to analyze your application's environment and print diagnostics +at startup, but also temporarily migrate properties at runtime for you. To enable that +feature, add the following dependency to your project: + +[source,xml,indent=0] +---- + + org.springframework.boot + spring-boot-properties-migrator + runtime + +---- + +WARNING: properties that are added late to the environment, such as when using +`@PropertySource`, will not be taken into account. + +NOTE: Once you're done with the migration, please make sure to remove this module from +your project's dependencies. + To upgrade an existing CLI installation, use the appropriate package manager command (for example, `brew upgrade`) or, if you manually installed the CLI, follow the <>, remembering to update