MacBook-Pro:deployment neo$ mvn help:describe -DgroupId=org.apache.maven.plugins -DartifactId=maven-war-plugin -Ddetail=true[INFO] Scanning for projects...[INFO] [INFO] ------------------------------------------------------------------------[INFO] Building Maven Stub Project (No POM) 1[INFO] ------------------------------------------------------------------------[INFO] [INFO] --- maven-help-plugin:2.2:describe (default-cli) @ standalone-pom ---[INFO] org.apache.maven.plugins:maven-war-plugin:3.1.0Name: Apache Maven WAR PluginDescription: Builds a Web Application Archive (WAR) file from the project output and its dependencies.Group Id: org.apache.maven.pluginsArtifact Id: maven-war-pluginVersion: 3.1.0Goal Prefix: warThis plugin has 4 goals:war:exploded Description: Create an exploded webapp in a specified directory. Implementation: org.apache.maven.plugins.war.WarExplodedMojo Language: java Bound to phase: package Available parameters: archive The archive configuration to use. See Maven Archiver Reference. archiveClasses (Default: false) Whether a JAR file will be created for the classes in the webapp. Using this optional configuration parameter will make the compiled classes to be archived into a JAR file and the classes directory will then be excluded from the webapp. cacheFile (Default: ${project.build.directory}/war/work/webapp-cache.xml) Required: true The file containing the webapp structure cache. containerConfigXML The path to a configuration file for the servlet container. Note that the file name may be different for different servlet containers. Apache Tomcat uses a configuration file named context.xml. The file will be copied to the META-INF directory. delimiters Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end. So, the default filtering delimiters might be specified as: ${*} @ Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can). dependentWarExcludes The comma separated list of tokens to exclude when doing a WAR overlay. Default is Overlay.DEFAULT_EXCLUDES dependentWarIncludes The comma separated list of tokens to include when doing a WAR overlay. Default is Overlay.DEFAULT_INCLUDES escapedBackslashesInFilePath (Default: false) To escape interpolated values with Windows path c:\foo\bar will be replaced with c:\\foo\\bar. escapeString Expression preceded with this String won't be interpolated. \${foo} will be replaced with ${foo}. filteringDeploymentDescriptors (Default: false) To filter deployment descriptors. Disabled by default. filters Filters (property files) to include during the interpolation of the pom.xml. includeEmptyDirectories (Default: false) (no description available) nonFilteredFileExtensions A list of file extensions that should not be filtered. Will be used when filtering webResources and overlays. outputFileNameMapping The file name mapping to use when copying libraries and TLDs. If no file mapping is set (default) the files are copied with their standard names. overlays The overlays to apply. Each element may contain: - id (defaults to currentBuild) - groupId (if this and artifactId are null, then the current project is treated as its own overlay) - artifactId (see above) - classifier - type - includes (a list of string patterns) - excludes (a list of string patterns) - filtered (defaults to false) - skip (defaults to false) - targetPath (defaults to root of webapp structure) recompressZippedFiles (Default: true) Indicates if zip archives (jar,zip etc) being added to the war should be compressed again. Compressing again can result in smaller archive size, but gives noticeably longer execution time. resourceEncoding (Default: ${project.build.sourceEncoding}) The encoding to use when copying filtered web resources. supportMultiLineFiltering (Default: false) Stop searching endToken at the end of line useCache (Default: false) Whether the cache should be used to save the status of the webapp across multiple runs. Experimental feature so disabled by default. useDefaultDelimiters (Default: true) Use default delimiters in addition to custom delimiters, if any. useJvmChmod (Default: true) use jvmChmod rather that cli chmod and forking process warSourceDirectory (Default: ${basedir}/src/main/webapp) Required: true Single directory for extra files to include in the WAR. This is where you place your JSP files. warSourceExcludes The comma separated list of tokens to exclude when copying the content of the warSourceDirectory. warSourceIncludes (Default: **) The comma separated list of tokens to include when copying the content of the warSourceDirectory. webappDirectory (Default: ${project.build.directory}/${project.build.finalName}) Required: true The directory where the webapp is built. webResources The list of webResources we want to transfer. webXml The path to the web.xml file to use. workDirectory (Default: ${project.build.directory}/war/work) Required: true Directory to unpack dependent WARs into if needed.war:help Description: Display help information on maven-war-plugin. Call mvn war:help -Ddetail=true -Dgoal= to display parameter details. Implementation: org.apache.maven.plugins.war.HelpMojo Language: java Available parameters: detail (Default: false) User property: detail If true, display all settable properties for each goal. goal User property: goal The name of the goal for which to show help. If unspecified, all goals will be displayed. indentSize (Default: 2) User property: indentSize The number of spaces per indentation level, should be positive. lineLength (Default: 80) User property: lineLength The maximum length of a display line, should be positive.war:inplace Description: Generate the webapp in the WAR source directory. Implementation: org.apache.maven.plugins.war.WarInPlaceMojo Language: java Available parameters: archive The archive configuration to use. See Maven Archiver Reference. archiveClasses (Default: false) Whether a JAR file will be created for the classes in the webapp. Using this optional configuration parameter will make the compiled classes to be archived into a JAR file and the classes directory will then be excluded from the webapp. cacheFile (Default: ${project.build.directory}/war/work/webapp-cache.xml) Required: true The file containing the webapp structure cache. containerConfigXML The path to a configuration file for the servlet container. Note that the file name may be different for different servlet containers. Apache Tomcat uses a configuration file named context.xml. The file will be copied to the META-INF directory. delimiters Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end. So, the default filtering delimiters might be specified as: ${*} @ Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can). dependentWarExcludes The comma separated list of tokens to exclude when doing a WAR overlay. Default is Overlay.DEFAULT_EXCLUDES dependentWarIncludes The comma separated list of tokens to include when doing a WAR overlay. Default is Overlay.DEFAULT_INCLUDES escapedBackslashesInFilePath (Default: false) To escape interpolated values with Windows path c:\foo\bar will be replaced with c:\\foo\\bar. escapeString Expression preceded with this String won't be interpolated. \${foo} will be replaced with ${foo}. filteringDeploymentDescriptors (Default: false) To filter deployment descriptors. Disabled by default. filters Filters (property files) to include during the interpolation of the pom.xml. includeEmptyDirectories (Default: false) (no description available) nonFilteredFileExtensions A list of file extensions that should not be filtered. Will be used when filtering webResources and overlays. outputFileNameMapping The file name mapping to use when copying libraries and TLDs. If no file mapping is set (default) the files are copied with their standard names. overlays The overlays to apply. Each element may contain: - id (defaults to currentBuild) - groupId (if this and artifactId are null, then the current project is treated as its own overlay) - artifactId (see above) - classifier - type - includes (a list of string patterns) - excludes (a list of string patterns) - filtered (defaults to false) - skip (defaults to false) - targetPath (defaults to root of webapp structure) recompressZippedFiles (Default: true) Indicates if zip archives (jar,zip etc) being added to the war should be compressed again. Compressing again can result in smaller archive size, but gives noticeably longer execution time. resourceEncoding (Default: ${project.build.sourceEncoding}) The encoding to use when copying filtered web resources. supportMultiLineFiltering (Default: false) Stop searching endToken at the end of line useCache (Default: false) Whether the cache should be used to save the status of the webapp across multiple runs. Experimental feature so disabled by default. useDefaultDelimiters (Default: true) Use default delimiters in addition to custom delimiters, if any. useJvmChmod (Default: true) use jvmChmod rather that cli chmod and forking process warSourceDirectory (Default: ${basedir}/src/main/webapp) Required: true Single directory for extra files to include in the WAR. This is where you place your JSP files. warSourceExcludes The comma separated list of tokens to exclude when copying the content of the warSourceDirectory. warSourceIncludes (Default: **) The comma separated list of tokens to include when copying the content of the warSourceDirectory. webappDirectory (Default: ${project.build.directory}/${project.build.finalName}) Required: true The directory where the webapp is built. webResources The list of webResources we want to transfer. webXml The path to the web.xml file to use. workDirectory (Default: ${project.build.directory}/war/work) Required: true Directory to unpack dependent WARs into if needed.war:war Description: Build a WAR file. Implementation: org.apache.maven.plugins.war.WarMojo Language: java Bound to phase: package Available parameters: archive The archive configuration to use. See Maven Archiver Reference. archiveClasses (Default: false) Whether a JAR file will be created for the classes in the webapp. Using this optional configuration parameter will make the compiled classes to be archived into a JAR file and the classes directory will then be excluded from the webapp. attachClasses (Default: false) Whether classes (that is the content of the WEB-INF/classes directory) should be attached to the project as an additional artifact. By default the classifier for the additional artifact is 'classes'. You can change it with the someclassifier parameter. If this parameter true, another project can depend on the classes by writing something like: myGroup myArtifact myVersion classes cacheFile (Default: ${project.build.directory}/war/work/webapp-cache.xml) Required: true The file containing the webapp structure cache. classesClassifier (Default: classes) The classifier to use for the attached classes artifact. classifier Classifier to add to the generated WAR. If given, the artifact will be an attachment instead. The classifier will not be applied to the JAR file of the project - only to the WAR file. containerConfigXML The path to a configuration file for the servlet container. Note that the file name may be different for different servlet containers. Apache Tomcat uses a configuration file named context.xml. The file will be copied to the META-INF directory. delimiters Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end. So, the default filtering delimiters might be specified as: Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can). dependentWarExcludes The comma separated list of tokens to exclude when doing a WAR overlay. Default is Overlay.DEFAULT_EXCLUDES dependentWarIncludes The comma separated list of tokens to include when doing a WAR overlay. Default is Overlay.DEFAULT_INCLUDES escapedBackslashesInFilePath (Default: false) To escape interpolated values with Windows path c:\foo\bar will be replaced with c:\\foo\\bar. escapeString Expression preceded with this String won't be interpolated. \${foo} will be replaced with ${foo}. failOnMissingWebXml Whether or not to fail the build if the web.xml file is missing. Set to false if you want your WAR built without a web.xml file. This may be useful if you are building an overlay that has no web.xml file. Starting with 3.1.0, this property defaults to false if the project depends on the Servlet 3.0 API or newer. filteringDeploymentDescriptors (Default: false) To filter deployment descriptors. Disabled by default. filters Filters (property files) to include during the interpolation of the pom.xml. includeEmptyDirectories (Default: false) (no description available) nonFilteredFileExtensions A list of file extensions that should not be filtered. Will be used when filtering webResources and overlays. outputDirectory (Default: ${project.build.directory}) Required: true The directory for the generated WAR. outputFileNameMapping The file name mapping to use when copying libraries and TLDs. If no file mapping is set (default) the files are copied with their standard names. overlays The overlays to apply. Each overlay element may contain: - id (defaults to currentBuild) - groupId (if this and artifactId are null, then the current project is treated as its own overlay) - artifactId (see above) - classifier - type - includes (a list of string patterns) - excludes (a list of string patterns) - filtered (defaults to false) - skip (defaults to false) - targetPath (defaults to root of webapp structure) packagingExcludes The comma separated list of tokens to exclude from the WAR before packaging. This option may be used to implement the skinny WAR use case. Note that you can use the Java Regular Expressions engine to include and exclude specific pattern using the expression %regex[]. Hint: read the about (?!Pattern). packagingIncludes The comma separated list of tokens to include in the WAR before packaging. By default everything is included. This option may be used to implement the skinny WAR use case. Note that you can use the Java Regular Expressions engine to include and exclude specific pattern using the expression %regex[]. primaryArtifact (Default: true) Whether this is the main artifact being built. Set to false if you don't want to install or deploy it to the local repository instead of the default one in an execution. recompressZippedFiles (Default: true) Indicates if zip archives (jar,zip etc) being added to the war should be compressed again. Compressing again can result in smaller archive size, but gives noticeably longer execution time. resourceEncoding (Default: ${project.build.sourceEncoding}) The encoding to use when copying filtered web resources. skip (Default: false) User property: maven.war.skip You can skip the execution of the plugin if you need to. Its use is NOT RECOMMENDED, but quite convenient on occasion. supportMultiLineFiltering (Default: false) Stop searching endToken at the end of line useCache (Default: false) Whether the cache should be used to save the status of the webapp across multiple runs. Experimental feature so disabled by default. useDefaultDelimiters (Default: true) Use default delimiters in addition to custom delimiters, if any. useJvmChmod (Default: true) use jvmChmod rather that cli chmod and forking process warSourceDirectory (Default: ${basedir}/src/main/webapp) Required: true Single directory for extra files to include in the WAR. This is where you place your JSP files. warSourceExcludes The comma separated list of tokens to exclude when copying the content of the warSourceDirectory. warSourceIncludes (Default: **) The comma separated list of tokens to include when copying the content of the warSourceDirectory. webappDirectory (Default: ${project.build.directory}/${project.build.finalName}) Required: true The directory where the webapp is built. webResources The list of webResources we want to transfer. webXml The path to the web.xml file to use. workDirectory (Default: ${project.build.directory}/war/work) Required: true Directory to unpack dependent WARs into if needed.[INFO] ------------------------------------------------------------------------[INFO] BUILD SUCCESS[INFO] ------------------------------------------------------------------------[INFO] Total time: 0.960 s[INFO] Finished at: 2017-08-03T14:33:18+08:00[INFO] Final Memory: 10M/155M[INFO] ------------------------------------------------------------------------
or alternatively, we can use an external build.xml. 4.0.0 my-test-app my-test-group 1.0-SNAPSHOT org.apache.maven.plugins maven-antrun-plugin 1.8 compile compile run The build.xml:
MacBook-Pro:api.netkiller.cn neo$ mvn help:describe -DgroupId=org.springframework.boot -DartifactId=spring-boot-maven-plugin -Ddetail=true[INFO] Scanning for projects...[INFO] [INFO] ------------------------------------------------------------------------[INFO] Building api 0.0.1-SNAPSHOT[INFO] ------------------------------------------------------------------------[INFO] [INFO] --- maven-help-plugin:2.2:describe (default-cli) @ api ---[INFO] org.springframework.boot:spring-boot-maven-plugin:1.5.6.RELEASEName: Spring Boot Maven PluginDescription: Spring Boot Maven PluginGroup Id: org.springframework.bootArtifact Id: spring-boot-maven-pluginVersion: 1.5.6.RELEASEGoal Prefix: spring-bootThis plugin has 6 goals:spring-boot:build-info Description: Generate a build-info.properties file based the content of the current MavenProject. Implementation: org.springframework.boot.maven.BuildInfoMojo Language: java Bound to phase: generate-resources Available parameters: additionalProperties Additional properties to store in the build-info.properties. Each entry is prefixed by build. in the generated build-info.properties. outputFile (Default: ${project.build.outputDirectory}/META-INF/build-info.properties) The location of the generated build-info.properties.spring-boot:help Description: Display help information on spring-boot-maven-plugin. Call mvn spring-boot:help -Ddetail=true -Dgoal= to display parameter details. Implementation: org.springframework.boot.maven.HelpMojo Language: java Available parameters: detail (Default: false) User property: detail If true, display all settable properties for each goal. goal User property: goal The name of the goal for which to show help. If unspecified, all goals will be displayed. indentSize (Default: 2) User property: indentSize The number of spaces per indentation level, should be positive. lineLength (Default: 80) User property: lineLength The maximum length of a display line, should be positive.spring-boot: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). Implementation: org.springframework.boot.maven.RepackageMojo Language: java Bound to phase: package Available parameters: attach (Default: true) Attach the repackaged archive to be installed and deployed. classifier Classifier to add to the artifact generated. If given, the artifact will be attached with that classifier and the main artifact will be deployed as the main artifact. If this is not given (default), it will replace the main artifact and only the repackaged artifact will be deployed. Attaching the artifact allows to deploy it alongside to the original one, see the maven documentation for more details. embeddedLaunchScript 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 that should be expanded in the embedded launch script. excludeArtifactIds User property: excludeArtifactIds Comma separated list of artifact names to exclude (exact match). excludeDevtools (Default: true) Exclude Spring Boot devtools from the repackaged archive. excludeGroupIds User property: excludeGroupIds Comma separated list of groupId names to exclude (exact match). excludes Collection of artifact definitions to exclude. The Exclude element defines a groupId and artifactId mandatory properties and an optional classifier property. executable (Default: false) Make a fully executable jar for *nix machines by prepending a launch script to the jar. Currently, some tools do not accept this format so you may not always be able to use this technique. For example, jar -xf may silently fail to extract a jar or war that has been made fully-executable. It is recommended that you only enable this option if you intend to execute it directly, rather than running it with java -jar or deploying it to a servlet container. finalName (Default: ${project.build.finalName}) Required: true Name of the generated archive. includes Collection of artifact definitions to include. The Include element defines a groupId and artifactId mandatory properties and an optional classifier property. includeSystemScope (Default: false) Include system scoped dependencies. layout 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. layoutFactory The layout factory that will be used to create the executable archive if no explicit layout is set. Alternative layouts implementations can be provided by 3rd parties. mainClass The name of the main class. If not specified the first compiled class found that contains a 'main' method will be used. outputDirectory (Default: ${project.build.directory}) Required: true Directory containing the generated archive. requiresUnpack A list of the libraries that must be unpacked from fat jars in order to run. Specify each library as a with a and a and they will be unpacked at runtime. skip (Default: false) User property: skip Skip the execution.spring-boot:run Description: Run an executable archive application. Implementation: org.springframework.boot.maven.RunMojo Language: java Bound to phase: validate Before this mojo executes, it will call: Phase: 'test-compile' Available parameters: addResources (Default: false) User property: run.addResources Add maven resources to the classpath directly, this allows live in-place editing of resources. Duplicate resources are removed from target/classes to prevent them to appear twice if ClassLoader.getResources() is called. Please consider adding spring-boot-devtools to your project instead as it provides this feature and many more. agent User property: run.agent Path to agent jar. NOTE: the use of agents means that processes will be started by forking a new JVM. arguments User property: run.arguments Arguments that should be passed to the application. On command line use commas to separate multiple arguments. classesDirectory (Default: ${project.build.outputDirectory}) Required: true Directory containing the classes and resource files that should be packaged into the archive. excludeArtifactIds User property: excludeArtifactIds Comma separated list of artifact names to exclude (exact match). excludeGroupIds User property: excludeGroupIds Comma separated list of groupId names to exclude (exact match). excludes Collection of artifact definitions to exclude. The Exclude element defines a groupId and artifactId mandatory properties and an optional classifier property. folders Additional folders besides the classes directory that should be added to the classpath. fork User property: fork Flag to indicate if the run processes should be forked. fork is automatically enabled if an agent, jvmArguments or working directory are specified, or if devtools is present. includes Collection of artifact definitions to include. The Include element defines a groupId and artifactId mandatory properties and an optional classifier property. jvmArguments User property: run.jvmArguments JVM arguments that should be associated with the forked process used to run the application. On command line, make sure to wrap multiple values between quotes. NOTE: the use of JVM arguments means that processes will be started by forking a new JVM. mainClass The name of the main class. If not specified the first compiled class found that contains a 'main' method will be used. noverify User property: run.noverify Flag to say that the agent requires -noverify. profiles User property: run.profiles The spring profiles to activate. Convenience shortcut of specifying the 'spring.profiles.active' argument. On command line use commas to separate multiple profiles. skip (Default: false) User property: skip Skip the execution. useTestClasspath (Default: false) User property: useTestClasspath Flag to include the test classpath when running. workingDirectory User property: run.workingDirectory Current working directory to use for the application. If not specified, basedir will be used. NOTE: the use of working directory means that processes will be started by forking a new JVM.spring-boot:start Description: Start a spring application. Contrary to the run goal, this does not block and allows other goal to operate on the application. This goal is typically used in integration test scenario where the application is started before a test suite and stopped after. Implementation: org.springframework.boot.maven.StartMojo Language: java Bound to phase: pre-integration-test Available parameters: addResources (Default: false) User property: run.addResources Add maven resources to the classpath directly, this allows live in-place editing of resources. Duplicate resources are removed from target/classes to prevent them to appear twice if ClassLoader.getResources() is called. Please consider adding spring-boot-devtools to your project instead as it provides this feature and many more. agent User property: run.agent Path to agent jar. NOTE: the use of agents means that processes will be started by forking a new JVM. arguments User property: run.arguments Arguments that should be passed to the application. On command line use commas to separate multiple arguments. classesDirectory (Default: ${project.build.outputDirectory}) Required: true Directory containing the classes and resource files that should be packaged into the archive. excludeArtifactIds User property: excludeArtifactIds Comma separated list of artifact names to exclude (exact match). excludeGroupIds User property: excludeGroupIds Comma separated list of groupId names to exclude (exact match). excludes Collection of artifact definitions to exclude. The Exclude element defines a groupId and artifactId mandatory properties and an optional classifier property. folders Additional folders besides the classes directory that should be added to the classpath. fork User property: fork Flag to indicate if the run processes should be forked. fork is automatically enabled if an agent, jvmArguments or working directory are specified, or if devtools is present. includes Collection of artifact definitions to include. The Include element defines a groupId and artifactId mandatory properties and an optional classifier property. jmxName The JMX name of the automatically deployed MBean managing the lifecycle of the spring application. jmxPort The port to use to expose the platform MBeanServer if the application needs to be forked. jvmArguments User property: run.jvmArguments JVM arguments that should be associated with the forked process used to run the application. On command line, make sure to wrap multiple values between quotes. NOTE: the use of JVM arguments means that processes will be started by forking a new JVM. mainClass The name of the main class. If not specified the first compiled class found that contains a 'main' method will be used. maxAttempts The maximum number of attempts to check if the spring application is ready. Combined with the 'wait' argument, this gives a global timeout value (30 sec by default) noverify User property: run.noverify Flag to say that the agent requires -noverify. profiles User property: run.profiles The spring profiles to activate. Convenience shortcut of specifying the 'spring.profiles.active' argument. On command line use commas to separate multiple profiles. skip (Default: false) User property: skip Skip the execution. useTestClasspath (Default: false) User property: useTestClasspath Flag to include the test classpath when running. wait The number of milli-seconds to wait between each attempt to check if the spring application is ready. workingDirectory User property: run.workingDirectory Current working directory to use for the application. If not specified, basedir will be used. NOTE: the use of working directory means that processes will be started by forking a new JVM.spring-boot:stop Description: Stop a spring application that has been started by the 'start' goal. Typically invoked once a test suite has completed. Implementation: org.springframework.boot.maven.StopMojo Language: java Bound to phase: post-integration-test Available parameters: fork User property: fork Flag to indicate if process to stop was forked. By default, the value is inherited from the MavenProject. If it is set, it must match the value used to StartMojo start the process. jmxName The JMX name of the automatically deployed MBean managing the lifecycle of the application. jmxPort The port to use to lookup the platform MBeanServer if the application has been forked. skip (Default: false) User property: skip Skip the execution.[INFO] ------------------------------------------------------------------------[INFO] BUILD SUCCESS[INFO] ------------------------------------------------------------------------[INFO] Total time: 0.976 s[INFO] Finished at: 2017-08-03T15:05:53+08:00[INFO] Final Memory: 12M/155M[INFO] ------------------------------------------------------------------------