From cd7add3e168b5383c36ad7a8a81f4c815e01df9d Mon Sep 17 00:00:00 2001 From: Janne Valkealahti Date: Wed, 22 May 2024 17:08:59 +0100 Subject: [PATCH] Update docs - Document ShellRunner changes - Fixes #1067 --- spring-shell-docs/modules/ROOT/pages/execution.adoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/spring-shell-docs/modules/ROOT/pages/execution.adoc b/spring-shell-docs/modules/ROOT/pages/execution.adoc index a5bebb98..da91e10f 100644 --- a/spring-shell-docs/modules/ROOT/pages/execution.adoc +++ b/spring-shell-docs/modules/ROOT/pages/execution.adoc @@ -50,3 +50,15 @@ spring: NOTE: Versions up to `3.2.x` had all runners enabled by default, starting from `3.3.x` only `NonInteractiveShellRunner` is enabled by default. + +Starting from `3.3.x` a `ShellRunner` interface has a new method: + +[source, java] +---- +default boolean run(String[] args) throws Exception { + return false; +} +---- + +IMPORTANT: This will the main api going forward and other existing methods taking boot's +`ApplicationArguments` has been deprecated and will be removed in future.