spring-boot/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/index.adoc

= Spring Boot Gradle Plugin Reference Guide
Andy Wilkinson, Scott Frederick
:doctype: book
:toc: left
:toclevels: 4
:numbered:
:sectanchors:
:icons: font
:hide-uri-scheme:
:docinfo: shared,private

:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin
:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md
:gradle-userguide: https://docs.gradle.org/current/userguide
:gradle-dsl: https://docs.gradle.org/current/dsl
:gradle-api: https://docs.gradle.org/current/javadoc
:application-plugin: {gradle-userguide}/application_plugin.html
:groovy-plugin: {gradle-userguide}/groovy_plugin.html
:java-plugin: {gradle-userguide}/java_plugin.html
:war-plugin: {gradle-userguide}/war_plugin.html
:maven-plugin: {gradle-userguide}/maven_plugin.html
:maven-publish-plugin: {gradle-userguide}/maven_publish_plugin.html
:software-component: {gradle-userguide}/software_model_extend.html
:kotlin-plugin: https://kotlinlang.org/docs/reference/using-gradle.html
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{gradle-project-version}
:api-documentation: {spring-boot-docs}/gradle-plugin/api
:spring-boot-reference: {spring-boot-docs}/reference/htmlsingle
:spring-boot-api: {spring-boot-docs}/api/org/springframework/boot
:version-properties-appendix: {spring-boot-reference}/#dependency-versions-properties
:build-info-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html
:boot-build-image-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html
:boot-jar-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/bundling/BootJar.html
:boot-war-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/bundling/BootWar.html
:boot-run-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/run/BootRun.html
:github-code: https://github.com/spring-projects/spring-boot/tree/{github-tag}
:buildpacks-reference: https://buildpacks.io/docs
:paketo-reference: https://paketo.io/docs
:paketo-java-reference: {paketo-reference}/buildpacks/language-family-buildpacks/java


[[introduction]]
== Introduction
The Spring Boot Gradle Plugin provides Spring Boot support in https://gradle.org[Gradle].
It allows you to package executable jar or war archives, run Spring Boot applications, and use the dependency management provided by `spring-boot-dependencies`.
Spring Boot's Gradle plugin requires Gradle 6 (6.3 or later).
Gradle 5.6 is also supported but this support is deprecated and will be removed in a future release.

In addition to this user guide, {api-documentation}[API documentation] is also available.

include::getting-started.adoc[]
include::managing-dependencies.adoc[]
include::packaging.adoc[]
include::packaging-oci-image.adoc[]
include::publishing.adoc[]
include::running.adoc[]
include::integrating-with-actuator.adoc[]
include::reacting.adoc[]
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`= Spring Boot Gradle Plugin Reference Guide`
Add documentation for gradle bootBuildImage task 2020-01-31 07:54:15 +08:00			`Andy Wilkinson, Scott Frederick`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`:doctype: book`
			`:toc: left`
			`:toclevels: 4`
			`:numbered:`
Add anchors to section headers in Gradle plugin docs Fixes gh-23402 2020-09-18 16:06:54 +08:00			`:sectanchors:`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`:icons: font`
			`:hide-uri-scheme:`
Add Spring-specific styling to Gradle Plugin's documentation This commit replaces the default Asciidoctor styling with Spring specific styling. First, we need to unzip the contents of the Spring Asciidoctor documentation resources provided by the `io.spring.docsresources:spring-docs-resources` distribution zip. This is done in a `/target/refdocs` folder. We then copy all files from `src/main/asciidoc` to the same location, and then launch the generation process. See gh-16327 2019-03-25 21:46:22 +08:00			`:docinfo: shared,private`

Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin`
			`:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md`
Use HTTPS URLs where applicable 2018-01-04 00:07:10 +08:00			`:gradle-userguide: https://docs.gradle.org/current/userguide`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`:gradle-dsl: https://docs.gradle.org/current/dsl`
Document the use of --args to pass arguments to bootRun Closes gh-1176 2018-09-06 20:08:40 +08:00			`:gradle-api: https://docs.gradle.org/current/javadoc`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`:application-plugin: {gradle-userguide}/application_plugin.html`
			`:groovy-plugin: {gradle-userguide}/groovy_plugin.html`
			`:java-plugin: {gradle-userguide}/java_plugin.html`
			`:war-plugin: {gradle-userguide}/war_plugin.html`
			`:maven-plugin: {gradle-userguide}/maven_plugin.html`
			`:maven-publish-plugin: {gradle-userguide}/maven_publish_plugin.html`
			`:software-component: {gradle-userguide}/software_model_extend.html`
			`:kotlin-plugin: https://kotlinlang.org/docs/reference/using-gradle.html`
Port the build to Gradle Closes gh-19609 Closes gh-19608 2020-01-10 21:48:43 +08:00			`:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{gradle-project-version}`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`:api-documentation: {spring-boot-docs}/gradle-plugin/api`
			`:spring-boot-reference: {spring-boot-docs}/reference/htmlsingle`
Add documentation for gradle bootBuildImage task 2020-01-31 07:54:15 +08:00			`:spring-boot-api: {spring-boot-docs}/api/org/springframework/boot`
Fix typo See gh-20049 2020-02-06 20:08:42 +08:00			`:version-properties-appendix: {spring-boot-reference}/#dependency-versions-properties`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`:build-info-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html`
Add support for building OCI images using the Gradle plugin Closes gh-19831 2020-01-22 22:54:32 +08:00			`:boot-build-image-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`:boot-jar-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/bundling/BootJar.html`
			`:boot-war-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/bundling/BootWar.html`
			`:boot-run-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/run/BootRun.html`
			`:github-code: https://github.com/spring-projects/spring-boot/tree/{github-tag}`
Add documentation for gradle bootBuildImage task 2020-01-31 07:54:15 +08:00			`:buildpacks-reference: https://buildpacks.io/docs`
Document runtime JVM configuration when building an image Fixes gh-21478 2021-04-10 02:46:41 +08:00			`:paketo-reference: https://paketo.io/docs`
			`:paketo-java-reference: {paketo-reference}/buildpacks/language-family-buildpacks/java`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00
Polish "Add Spring-specific styling to Gradle Plugin's documentation" Closes gh-16327 2019-04-02 22:22:13 +08:00
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`[[introduction]]`
			`== Introduction`
Use one sentence per line in Actuator and Gradle plugin doc source Closes gh-18185 2019-09-09 17:59:49 +08:00			`The Spring Boot Gradle Plugin provides Spring Boot support in https://gradle.org[Gradle].`
			It allows you to package executable jar or war archives, run Spring Boot applications, and use the dependency management provided by `spring-boot-dependencies`.
Raise the minimum supported version of Gradle 6 to 6.3 Closes gh-20532 2020-04-01 01:51:45 +08:00			`Spring Boot's Gradle plugin requires Gradle 6 (6.3 or later).`
			`Gradle 5.6 is also supported but this support is deprecated and will be removed in a future release.`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00
			`In addition to this user guide, {api-documentation}[API documentation] is also available.`

			`include::getting-started.adoc[]`
			`include::managing-dependencies.adoc[]`
			`include::packaging.adoc[]`
Add documentation for gradle bootBuildImage task 2020-01-31 07:54:15 +08:00			`include::packaging-oci-image.adoc[]`
Drop custom software component in favor of just publishing an artifact Previously, Spring Boot's Gradle plugin provided custom software components (bootJava and bootWeb) for publishing the artifacts created by the standard bootJar and bootWar tasks respectively. Providing a custom software component requires the usage of some of Gradle's internal APIs and this has now proven to be more trouble than it is worth. This commit removes the custom software component and documents how to publish the artifact created by a BootJar or BootWar task directly instead. Closes gh-9153 2017-05-31 21:14:55 +08:00			`include::publishing.adoc[]`
Provide separate documentation (API and reference) for Gradle plugin 2017-03-15 04:51:23 +08:00			`include::running.adoc[]`
			`include::integrating-with-actuator.adoc[]`
Add Kotlin DSL examples to Gradle Plugin's documentation See gh-14585 2018-09-23 04:39:36 +08:00			`include::reacting.adoc[]`