Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in / Register
Toggle navigation
S
spring-boot
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DEMO
spring-boot
Commits
b5ef6d40
Commit
b5ef6d40
authored
Jan 10, 2020
by
Andy Wilkinson
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update README to reflect the build now using Gradle
Closes gh-19617
parent
8a28e9bf
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
45 deletions
+11
-45
README.adoc
README.adoc
+11
-45
No files found.
README.adoc
View file @
b5ef6d40
...
@@ -93,63 +93,29 @@ requests. If you want to raise an issue, please follow the recommendations below
...
@@ -93,63 +93,29 @@ requests. If you want to raise an issue, please follow the recommendations below
== Building from Source
== Building from Source
You don't need to build from source to use Spring Boot (binaries in
You don't need to build from source to use Spring Boot (binaries in
https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and
https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and
greatest, Spring Boot can be easily built with the
greatest, Spring Boot can be built and published to your local Maven cache using the
https://github.com/takari/maven-wrapper[maven wrapper]. You also need JDK 1.8.
https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper]. You also
need JDK 1.8.
[indent=0]
[indent=0]
----
----
$ ./
mvnw clean instal
l
$ ./
gradlew publishToMavenLoca
l
----
----
If you want to build with the regular `mvn` command, you will need
This will build all of the jars and documentation and publish every to your local
https://maven.apache.org/run-maven/index.html[Maven v3.5.0 or above].
Maven cache. It won't run any of the tests. If you want to build everything, use the
`build` task:
NOTE: You may need to increase the amount of memory available to Maven by setting
[indent=0]
a `MAVEN_OPTS` environment variable with the value `-Xmx512m`. Remember
----
to set the corresponding property in your IDE as well if you are building and running
$ ./gradlew build
tests there (e.g. in Eclipse go to `Preferences->Java->Installed JREs` and edit the
----
JRE definition so that all processes are launched with those arguments). This property
is automatically set if you use the maven wrapper.
_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests,
_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests,
and in particular please fill out the
and in particular please fill out the
https://support.springsource.com/spring_committer_signup[Contributor's Agreement]
https://support.springsource.com/spring_committer_signup[Contributor's Agreement]
before your first change, however trivial._
before your first change, however trivial._
=== Building reference documentation
First of all, make sure you have built the project:
[indent=0]
----
$ ./mvnw clean install
----
The reference documentation requires the documentation of the Maven plugin to be
available so you need to build that first since it's not generated by default.
[indent=0]
----
$ ./mvnw clean install -pl spring-boot-project/spring-boot-tools/spring-boot-maven-plugin -Pdefault,full
----
The documentation also includes auto-generated information about the starters. You might
have that in your local repository already (per the first step) but if you want to refresh
it:
[indent=0]
----
$ ./mvnw clean install -f spring-boot-project/spring-boot-starters
----
Once this is done, you can build the reference documentation with the command below:
[indent=0]
----
$ ./mvnw clean prepare-package -pl spring-boot-project/spring-boot-docs -Pdefault,full
----
TIP: The generated documentation is available from `spring-boot-project/spring-boot-docs/target/generated-docs/reference/html`
== Modules
== Modules
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment