From b09939856c1424467b8d0640cf3b8de77ff984ba Mon Sep 17 00:00:00 2001 From: Janne Valkealahti Date: Wed, 14 Aug 2024 07:48:48 +0100 Subject: [PATCH] Update docs for getting started - Add note for interactive mode - Fixes #1108 --- .../modules/ROOT/pages/getting-started.adoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/spring-shell-docs/modules/ROOT/pages/getting-started.adoc b/spring-shell-docs/modules/ROOT/pages/getting-started.adoc index f4b7bc01..82d302af 100644 --- a/spring-shell-docs/modules/ROOT/pages/getting-started.adoc +++ b/spring-shell-docs/modules/ROOT/pages/getting-started.adoc @@ -66,6 +66,18 @@ dependencyManagement { } ---- +IMPORTANT: Versions up to `3.2.x` had all runners enabled by default, starting from `3.3.x` +only `NonInteractiveShellRunner` is enabled by default. This means you need to enable +`InteractiveShellRunner` to get REPL. + +[source, yaml] +---- +spring: + shell: + interactive: + enabled: true +---- + CAUTION: Given that Spring Shell starts the REPL (Read-Eval-Print-Loop) because this dependency is present, you need to either skip tests when you build (`-DskipTests`) throughout this tutorial or remove the sample integration test that was generated