Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Port the build to Gradle

Browse Source 
Closes gh-19609
Closes gh-19608
This commit is contained in:
Andy Wilkinson
2020-01-10 13:48:43 +00:00
parent abe95fa8a7
commit ce99db1902
974 changed files with 17108 additions and 26596 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
CONTRIBUTING.adoc
View File

@@ -49,11 +49,13 @@ added after the original pull request but before a merge.
* We use the https://github.com/spring-io/spring-javaformat/[Spring JavaFormat] project
to apply code formatting conventions. If you use Eclipse and you follow the '`Importing
into eclipse`' instructions below you should get project specific formatting
automatically. You can also install the https://github.com/spring-io/spring-javaformat/#intellij-idea[Spring JavaFormat IntelliJ Plugin]
or format the code from the Maven build by running
`./mvnw io.spring.javaformat:spring-javaformat-maven-plugin:apply`.
automatically. You can also install the
https://github.com/spring-io/spring-javaformat/#intellij-idea[Spring JavaFormat IntelliJ
Plugin] or format the code from the Gradle build by running
`./gradlew format`.
* The build includes checkstyle rules for many of our code conventions. Run
`./mvnw validate` if you want to check you changes are compliant.
`./gradlew checkstyleMain checkstyleTest` if you want to check you changes are
compliant.
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an
`@author` tag identifying you, and preferably at least a paragraph on what the class is
for.
@@ -75,65 +77,24 @@ added after the original pull request but before a merge.
If you don't have an IDE preference we would recommend that you use
https://spring.io/tools/sts[Spring Tools Suite] or
https://eclipse.org[Eclipse] when working with the code. We use the
https://eclipse.org/m2e/[M2Eclipse] eclipse plugin for maven support. Other IDEs and tools
should also work without issue.
https://projects.eclipse.org/projects/tools.buildship[Buildship] Eclipse plugin for Gradle
support. Other IDEs and tools should also work without issue.
=== Building from Source
Spring Boot source can be built from the command line using
https://maven.apache.org/run-maven/index.html[Apache Maven] on JDK 1.8 or above. We
include '`Maven Wrapper`' scripts (`./mvnw` or `mvnw.bat`) that you can run rather than
needing to install Maven locally.
Spring Boot source can be built from the command line using https://gradle.org[Gradle] on
JDK 1.8 or above. We include https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle's
wrapper scripts] (`./gradlew` or `gradlew.bat`) that you can run rather than needing to
install Gradle locally.
==== Default Build
The project can be built from the root directory using the standard Maven command:
The project can be built from the root directory using the standard Gradle command:
[indent=0]
----
$ ./mvnw clean install
$ ./gradlew build
----
NOTE: You may need to increase the amount of memory available to Maven by setting
a `MAVEN_OPTS` environment variable with the value `-Xmx512m`
If you are rebuilding often, you might also want to skip the tests and the execution of
checkstyle until you are ready to submit a pull request:
[indent=0]
----
$ ./mvnw clean install -DskipTests -Pfast
----
==== Full Build
You can run a full build using the following command:
[indent=0]
----
$ ./mvnw -Pfull clean install
----
NOTE: As for the standard build, you may need to increase the amount of memory available
to Maven by setting a `MAVEN_OPTS` environment variable with the value `-Xmx512m`. We
generate more artifacts when running the full build (such as Javadoc jars), so you may
find the process a little slower than the standard build.
[TIP]
====
If you want to run a build without the smoke tests and integration tests, building the
`spring-boot-project` module is enough. You can cd there and run the same command, or you
can run this from the top-level directory:
[indent=0]
----
$ ./mvnw -f spring-boot-project -Pfull clean install
----
====
=== Importing into Eclipse
@@ -141,9 +102,6 @@ You can import the Spring Boot code into any Eclipse 2019-09-based distribution.
easiest way to setup a new environment is to use the Eclipse Installer with the provided
`spring-boot-project.setup` file (in the `/eclipse` folder).
NOTE: Due to m2e issue https://bugs.eclipse.org/bugs/show_bug.cgi?id=548652[#548652] you need to be running m2e 1.14.0 or higher.
An early milestone is available from https://download.eclipse.org/technology/m2e/milestones/1.14/.
==== Using the Eclipse Installer
@@ -169,9 +127,6 @@ Once complete you should find that a local workspace has been provisioned comple
all required Eclipse plugins. Projects will be grouped into working-sets to make the code
easier to navigate.
If you want to work on the `spring-boot-gradle-plugin` you should remove the imported Maven
project and reimport it as a Gradle project.
TIP: If you see import errors with `com.sun` packages make sure you have setup a valid
`JavaSE-1.8` environment. From preferences select "`Java`", "`Installed JREs`",
"`Execution Environments`" and make sure "`JavaSE-1.8`" points to a Java 1.8
@@ -179,13 +134,13 @@ install (we use AdoptOpenJDK on our CI).
==== Manual Installation with M2Eclipse
==== Manual Installation with Buildship
If you prefer to install Eclipse yourself you should use the
https://eclipse.org/m2e/[M2Eclipse] eclipse plugin. If you don't already have m2eclipse
installed it is available from the "`Eclipse marketplace`".
https://projects.eclipse.org/projects/tools.buildship[Buildship] Eclipse plugin. If you
don't already have Buildship installed it is available from the "`Eclipse marketplace`".
Spring Boot includes project specific source formatting settings, in order to have these
work with m2eclipse, we provide an additional Eclipse plugin that you can install:
work with Buildship, we provide an additional Eclipse plugin that you can install:
@@ -197,21 +152,13 @@ work with m2eclipse, we provide an additional Eclipse plugin that you can instal
NOTE: The plugin is optional. Projects can be imported without the plugins, your code
changes just won't be automatically formatted.
With the requisite eclipse plugins installed you can select
`import existing maven projects` from the `file` menu to import the code. You will
need to import the root `spring-boot` pom and the `spring-boot-smoke-tests` pom separately.
With the requisite Eclipse plugins installed you can select
`Gradle -> Existing Gradle project` from the `File -> Import…` menu to import the code.
=== Importing into IntelliJ IDEA
**Please, do this first!**
Go to `Preferences | Build, Execution, Deployment | Build Tools | Maven | Importing`
and set `VM options for importer` to `-Xmx2g` to allocate sufficient memory for IDEA's
Maven import process to parse the Spring Boot project structure. _Not doing so could
mean the import fails silently, leaving the project setup incomplete._
For the actual import use "`File`" -> "`Open`" and select the root `pom.xml`, or the
`spring-boot-project/pom.xml` if you only want the Spring Boot project sources.
Use "`File`" -> "`Open`" and then select the root `build.gradle` file to import the code.
@@ -239,18 +186,10 @@ needs to be added.
=== Importing into Other IDEs
Maven is well supported by most Java IDEs. Refer to your vendor documentation.
Gradle is well supported by most Java IDEs. Refer to your vendor documentation.
== Integration Tests
The smoke tests run as part of the build when you `./mvnw install`.
Due to the fact that they make use of the `spring-boot-maven-plugin`
they cannot be called directly, and so instead are launched via the
`maven-invoker-plugin`. If you encounter build failures running the integration tests,
check the `build.log` file in the appropriate smoke test directory.
== Cloning the git repository on Windows
Some files in the git repository may exceed the Windows maximum file path (260
characters), depending on where you clone the repository. If you get `Filename too long`