spring-boot:repackage
Full name:
org.springframework.boot:spring-boot-maven-plugin:1.3.0.RELEASE:repackage
Description:
Repackages existing JAR and WAR archives so that they can be
executed from the command line using java -jar. With
layout=NONE can also be used simply to package a JAR
with nested dependencies (and no main class, so not executable).
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope: compile+runtime.
- Requires dependency collection of artifacts in scope: compile+runtime.
- The goal is thread-safe and supports parallel builds.
- Since version: 1.1.
- Binds by default to the lifecycle phase: package.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| finalName | String | 1.0 | Name of the generated archive. Default value is: ${project.build.finalName}. |
| outputDirectory | File | 1.0 | Directory containing the generated archive. Default value is: ${project.build.directory}. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| classifier | String | 1.0 | Classifier to add to the artifact generated. If given, the artifact
will be attached. If this is not given, it will merely be written
to the output directory according to the finalName. Attaching the
artifact allows to deploy it alongside to the original one, see the
maven documentation for more details. |
| embeddedLaunchScript | File | 1.3 | The embedded launch script to prepend to the front of the jar if it
is fully executable. If not specified the 'Spring Boot' default
script will be used. |
| embeddedLaunchScriptProperties | Properties | 1.3 | Properties that should be expanded in the embedded launch script. |
| excludeArtifactIds | String | 1.1 | Comma separated list of artifact names to exclude (exact match). User property is: excludeArtifactIds. |
| excludeDevtools | boolean | 1.3 | Exclude Spring Boot devtools. Default value is: false. |
| excludeGroupIds | String | 1.1 | Comma separated list of groupId names to exclude (exact match). User property is: excludeGroupIds. |
| excludes | List | 1.1 | Collection of artifact definitions to exclude. The
Exclude element defines a groupId and
artifactId mandatory properties and an optional
classifier property. |
| executable | boolean | 1.3 | Make a fully executable jar for *nix machines by prepending a
launch script to the jar. Default value is: false. |
| includes | List | 1.2 | Collection of artifact definitions to include. The
Include element defines a groupId and
artifactId mandatory properties and an optional
classifier property. |
| layout | RepackageMojo$LayoutType | 1.0 | The type of archive (which corresponds to how the dependencies are
laid out inside it). Possible values are JAR, WAR, ZIP, DIR, NONE.
Defaults to a guess based on the archive type. |
| mainClass | String | 1.0 | The name of the main class. If not specified the first compiled
class found that contains a 'main' method will be used. |
| requiresUnpack | List | 1.1 | A list of the libraries that must be unpacked from fat jars in
order to run. Specify each library as a
<dependency> with a <groupId>
and a <artifactId> and they will be unpacked at
runtime in $TMPDIR/spring-boot-libs. |
| skip | boolean | 1.2 | Skip the execution. Default value is: false. User property is: skip. |
Parameter Details
Classifier to add to the artifact generated. If given, the artifact
will be attached. If this is not given, it will merely be written
to the output directory according to the finalName. Attaching the
artifact allows to deploy it alongside to the original one, see the
maven documentation for more details.
- Type: java.lang.String
- Since: 1.0
- Required: No
The embedded launch script to prepend to the front of the jar if it
is fully executable. If not specified the 'Spring Boot' default
script will be used.
- Type: java.io.File
- Since: 1.3
- Required: No
embeddedLaunchScriptProperties:
Properties that should be expanded in the embedded launch script.
- Type: java.util.Properties
- Since: 1.3
- Required: No
Comma separated list of artifact names to exclude (exact match).
- Type: java.lang.String
- Since: 1.1
- Required: No
- User Property: excludeArtifactIds
Exclude Spring Boot devtools.
- Type: boolean
- Since: 1.3
- Required: No
- Default: false
Comma separated list of groupId names to exclude (exact match).
- Type: java.lang.String
- Since: 1.1
- Required: No
- User Property: excludeGroupIds
Collection of artifact definitions to exclude. The
Exclude element defines a groupId and
artifactId mandatory properties and an optional
classifier property.
- Type: java.util.List
- Since: 1.1
- Required: No
Make a fully executable jar for *nix machines by prepending a
launch script to the jar.
- Type: boolean
- Since: 1.3
- Required: No
- Default: false
Name of the generated archive.
- Type: java.lang.String
- Since: 1.0
- Required: Yes
- Default: ${project.build.finalName}
Collection of artifact definitions to include. The
Include element defines a groupId and
artifactId mandatory properties and an optional
classifier property.
- Type: java.util.List
- Since: 1.2
- Required: No
The type of archive (which corresponds to how the dependencies are
laid out inside it). Possible values are JAR, WAR, ZIP, DIR, NONE.
Defaults to a guess based on the archive type.
- Type: org.springframework.boot.maven.RepackageMojo$LayoutType
- Since: 1.0
- Required: No
The name of the main class. If not specified the first compiled
class found that contains a 'main' method will be used.
- Type: java.lang.String
- Since: 1.0
- Required: No
Directory containing the generated archive.
- Type: java.io.File
- Since: 1.0
- Required: Yes
- Default: ${project.build.directory}
A list of the libraries that must be unpacked from fat jars in
order to run. Specify each library as a
<dependency> with a <groupId>
and a <artifactId> and they will be unpacked at
runtime in $TMPDIR/spring-boot-libs.
- Type: java.util.List
- Since: 1.1
- Required: No
skip:
Skip the execution.
- Type: boolean
- Since: 1.2
- Required: No
- User Property: skip
- Default: false