Skip to content

Commit 30cb15a

Browse files
committed
Update docs to note that Gradle 3 is not supported
Breaking API changes in Gradle 3.0 make it impossible to support it reliably alongside Gradle 1 and 2 without mainintaining multiple versions of our Gradle plugin. This commit updates the documentation to note that Gradle 3 is not supported. Closes gh-6880
1 parent b8833c4 commit 30cb15a

File tree

4 files changed

+15
-13
lines changed

4 files changed

+15
-13
lines changed

spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ BootRepackage task and instructed it to work with only `clientJar` task and
454454
----
455455

456456
The configuration that we are referring to in `BootRepackage` is a normal
457-
http://www.gradle.org/docs/current/dsl/org.gradle.api.artifacts.Configuration.html[Gradle
457+
{gradle-dsl}/org.gradle.api.artifacts.Configuration.html[Gradle
458458
configuration]. In the above example we created a new configuration named
459459
`mycustomconfiguration` instructing it to derive from a `runtime` and exclude the `log4j`
460460
group. If the `clientBoot` task is executed, the repackaged boot jar will have all
@@ -598,8 +598,7 @@ using Gradle and how you're trying to publish the artifacts.
598598
==== Configuring Gradle to produce a pom that inherits dependency management
599599
The following is an example of configuring Gradle to generate a pom that inherits
600600
from `spring-boot-starter-parent`. Please refer to the
601-
http://www.gradle.org/docs/current/userguide/userguide.html[Gradle User Guide] for
602-
further information.
601+
{gradle-user-guide}/userguide.html[Gradle User Guide] for further information.
603602

604603
[source,groovy,indent=0,subs="verbatim,attributes"]
605604
----

spring-boot-docs/src/main/asciidoc/getting-started.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,13 @@ diverge from the defaults.
3737
[[getting-started-system-requirements]]
3838
== System Requirements
3939
By default, Spring Boot {spring-boot-version} requires http://www.java.com[Java 7] and
40-
Spring Framework {spring-version} or above. You can use Spring Boot with Java 6 with some additional
41-
configuration. See <<howto.adoc#howto-use-java-6>> for more details. Explicit build support
42-
is provided for Maven (3.2+) and Gradle (1.12+).
40+
Spring Framework {spring-version} or above. You can use Spring Boot with Java 6 with some
41+
additional configuration. See <<howto.adoc#howto-use-java-6>> for more details. Explicit
42+
build support is provided for Maven (3.2+) and Gradle (1.12 or 2.x). Gradle 3 is not
43+
supported.
4344

44-
TIP: Although you can use Spring Boot with Java 6 or 7, we generally recommend Java 8 if at
45-
all possible.
45+
TIP: Although you can use Spring Boot with Java 6 or 7, we generally recommend Java 8 if
46+
at all possible.
4647

4748
=== Servlet containers
4849
The following embedded servlet containers are supported out of the box:
@@ -200,8 +201,9 @@ scope.
200201

201202
[[getting-started-gradle-installation]]
202203
==== Gradle installation
203-
Spring Boot is compatible with Gradle 1.12 or above. If you don't already have Gradle
204-
installed you can follow the instructions at http://www.gradle.org/.
204+
Spring Boot is compatible with Gradle 1.12 or 2.x. 2.14.1 is recommended. Gradle 3 is not
205+
supported. If you don't already have Gradle installed you can follow the instructions at
206+
http://www.gradle.org/.
205207

206208
Spring Boot dependencies can be declared using the `org.springframework.boot` `group`.
207209
Typically your project will declare dependencies to one or more
@@ -213,8 +215,7 @@ that can be used to simplify dependency declarations and to create executable ja
213215
****
214216
The Gradle Wrapper provides a nice way of "`obtaining`" Gradle when you need to build a
215217
project. It's a small script and library that you commit alongside your code to bootstrap
216-
the build process. See http://www.gradle.org/docs/current/userguide/gradle_wrapper.html
217-
for details.
218+
the build process. See {gradle-user-guide}/gradle_wrapper.html for details.
218219
****
219220

220221
Here is a typical `build.gradle` file:

spring-boot-docs/src/main/asciidoc/index.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson;
4242
:gradle-userguide: http://www.gradle.org/docs/current/userguide
4343
:propdeps-plugin: https://github.com/spring-projects/gradle-plugins/tree/master/propdeps-plugin
4444
:ant-manual: http://ant.apache.org/manual
45+
:gradle-user-guide: https://docs.gradle.org/2.14.1/userguide
46+
:gradle-dsl: https://docs.gradle.org/2.14.1/dsl
4547
// ======================================================================================
4648

4749
include::documentation-overview.adoc[]

spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -791,7 +791,7 @@ If you can't directly import your project into your IDE, you may be able to gene
791791
metadata using a build plugin. Maven includes plugins for
792792
http://maven.apache.org/plugins/maven-eclipse-plugin/[Eclipse] and
793793
http://maven.apache.org/plugins/maven-idea-plugin/[IDEA]; Gradle offers plugins
794-
for http://www.gradle.org/docs/current/userguide/ide_support.html[various IDEs].
794+
for {gradle-user-guide}/userguide.html[various IDEs].
795795

796796
TIP: If you accidentally run a web application twice you will see a "`Port already in
797797
use`" error. STS users can use the `Relaunch` button rather than `Run` to ensure that

0 commit comments

Comments
 (0)