Commit a64e26fc authored by Scott Frederick's avatar Scott Frederick

Polish plugin documentation headings

parent dc94a876
...@@ -45,7 +45,7 @@ Overriding versions may cause compatibility issues and should be done with care. ...@@ -45,7 +45,7 @@ Overriding versions may cause compatibility issues and should be done with care.
[[managing-dependencies-using-in-isolation]] [[managing-dependencies-using-in-isolation]]
=== Using Spring Boot's dependency management in isolation === Using Spring Boot's Dependency Management in Isolation
Spring Boot's dependency management can be used in a project without applying Spring Boot's plugin to that project. Spring Boot's dependency management can be used in a project without applying Spring Boot's plugin to that project.
The `SpringBootPlugin` class provides a `BOM_COORDINATES` constant that can be used to import the bom without having to know its group ID, artifact ID, or version. The `SpringBootPlugin` class provides a `BOM_COORDINATES` constant that can be used to import the bom without having to know its group ID, artifact ID, or version.
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
[[publishing-your-application-maven]] [[publishing-your-application-maven]]
=== Publishing with the `maven` Plugin === Publishing with the Maven Plugin
When the {maven-plugin}[`maven` plugin] is applied, an `Upload` task for the `bootArchives` configuration named `uploadBootArchives` is automatically created. When the {maven-plugin}[`maven` plugin] is applied, an `Upload` task for the `bootArchives` configuration named `uploadBootArchives` is automatically created.
By default, the `bootArchives` configuration contains the archive produced by the `bootJar` or `bootWar` task. By default, the `bootArchives` configuration contains the archive produced by the `bootJar` or `bootWar` task.
The `uploadBootArchives` task can be configured to publish the archive to a Maven repository: The `uploadBootArchives` task can be configured to publish the archive to a Maven repository:
...@@ -24,7 +24,7 @@ include::../gradle/publishing/maven.gradle.kts[tags=upload] ...@@ -24,7 +24,7 @@ include::../gradle/publishing/maven.gradle.kts[tags=upload]
[[publishing-your-application-maven-publish]] [[publishing-your-application-maven-publish]]
=== Publishing with the `maven-publish` Plugin === Publishing with the Maven-publish Plugin
To publish your Spring Boot jar or war, add it to the publication using the `artifact` method on `MavenPublication`. To publish your Spring Boot jar or war, add it to the publication using the `artifact` method on `MavenPublication`.
Pass the task that produces that artifact that you wish to publish to the `artifact` method. Pass the task that produces that artifact that you wish to publish to the `artifact` method.
For example, to publish the artifact produced by the default `bootJar` task: For example, to publish the artifact produced by the default `bootJar` task:
...@@ -44,7 +44,7 @@ include::../gradle/publishing/maven-publish.gradle.kts[tags=publishing] ...@@ -44,7 +44,7 @@ include::../gradle/publishing/maven-publish.gradle.kts[tags=publishing]
[[publishing-your-application-distribution]] [[publishing-your-application-distribution]]
=== Distributing with the `application` Plugin === Distributing with the Application Plugin
When the {application-plugin}[`application` plugin] is applied a distribution named `boot` is created. When the {application-plugin}[`application` plugin] is applied a distribution named `boot` is created.
This distribution contains the archive produced by the `bootJar` or `bootWar` task and scripts to launch it on Unix-like platforms and Windows. This distribution contains the archive produced by the `bootJar` or `bootWar` task and scripts to launch it on Unix-like platforms and Windows.
Zip and tar distributions can be built by the `bootDistZip` and `bootDistTar` tasks respectively. Zip and tar distributions can be built by the `bootDistZip` and `bootDistTar` tasks respectively.
......
[[repackage]] [[repackage]]
== Packaging executable archives == Packaging Executable Archives
The plugin can create executable archives (jar files and war files) that contain all of an application's dependencies and can then be run with `java -jar`. The plugin can create executable archives (jar files and war files) that contain all of an application's dependencies and can then be run with `java -jar`.
...@@ -75,7 +75,7 @@ The `layout` property defaults to a value determined by the archive type (`jar` ...@@ -75,7 +75,7 @@ The `layout` property defaults to a value determined by the archive type (`jar`
[[repackage-layers]] [[repackage-layers]]
=== Layered jars === Layered Jars
A repackaged jar contains the application's classes and dependencies in `BOOT-INF/classes` and `BOOT-INF/lib` respectively. A repackaged jar contains the application's classes and dependencies in `BOOT-INF/classes` and `BOOT-INF/lib` respectively.
For cases where a docker image needs to be built from the contents of the jar, it's useful to be able to separate these folders further so that they can be written into distinct layers. For cases where a docker image needs to be built from the contents of the jar, it's useful to be able to separate these folders further so that they can be written into distinct layers.
...@@ -116,7 +116,7 @@ Content that is least likely to change should be added first, followed by layers ...@@ -116,7 +116,7 @@ Content that is least likely to change should be added first, followed by layers
[[repackage-layers-configuration]] [[repackage-layers-configuration]]
==== Custom Layers configuration ==== Custom Layers Configuration
Depending on your application, you may want to tune how layers are created and add new ones. Depending on your application, you may want to tune how layers are created and add new ones.
This can be done using a separate configuration file that should be registered as shown below: This can be done using a separate configuration file that should be registered as shown below:
...@@ -530,7 +530,7 @@ This example excludes any artifact belonging to the `com.foo` group: ...@@ -530,7 +530,7 @@ This example excludes any artifact belonging to the `com.foo` group:
[[repackage-layered-jars-tools]] [[repackage-layered-jars-tools]]
==== Layered jar tools ==== Layered Jar Tools
When you create a layered jar, the `spring-boot-jarmode-layertools` jar will be added as a dependency to your jar. When you create a layered jar, the `spring-boot-jarmode-layertools` jar will be added as a dependency to your jar.
With this jar on the classpath, you can launch your application in a special mode which allows the bootstrap code to run something entirely different from your application, for example, something that extracts the layers. With this jar on the classpath, you can launch your application in a special mode which allows the bootstrap code to run something entirely different from your application, for example, something that extracts the layers.
If you wish to exclude this dependency, you can do so in the following manner: If you wish to exclude this dependency, you can do so in the following manner:
...@@ -559,7 +559,7 @@ If you wish to exclude this dependency, you can do so in the following manner: ...@@ -559,7 +559,7 @@ If you wish to exclude this dependency, you can do so in the following manner:
[[repackage-layered-jars-additional-layers]] [[repackage-layered-jars-additional-layers]]
==== Custom layers configuration ==== Custom Layers Configuration
The default setup splits dependencies into snapshot and non-snapshot, however, you may have more complex rules. The default setup splits dependencies into snapshot and non-snapshot, however, you may have more complex rules.
For example, you may want to isolate company-specific dependencies of your project in a dedicated layer. For example, you may want to isolate company-specific dependencies of your project in a dedicated layer.
The following `layers.xml` configuration shown one such setup: The following `layers.xml` configuration shown one such setup:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment