Skip to content

Commit

Permalink
improves shared-docs bootable jar section, to give more relevance to …
Browse files Browse the repository at this point in the history
…the bootable-jar config element, and also document the alternative java -jar command to start the bootable jar
  • Loading branch information
emmartins committed Nov 12, 2024
1 parent 156ab0a commit e5b4132
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
16 changes: 13 additions & 3 deletions shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ endif::mavenServerProvisioningCommand[]

You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart.

The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building:
The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which activates the bootable JAR packaging when provisioning {productName}, through the `<bootable-jar>true</bootable-jar>` configuration element:

[source,xml,subs="attributes+"]
----
Expand Down Expand Up @@ -52,7 +52,7 @@ The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, whi
</profile>
----

The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar`
The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar file is named `{artifactId}-bootable.jar`, and may be found in the `target` directory.

.Procedure

Expand All @@ -69,6 +69,15 @@ $ mvn clean {mavenServerProvisioningCommand}
----
$ mvn wildfly:start-jar
----
+
[NOTE]
====
You may also start the bootable jar without Maven, using the `java` command.
[source,subs="attributes+",options="nowrap"]
----
$ java -jar target/{artifactId}-bootable.jar
----
====

. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated.
+
Expand All @@ -82,4 +91,5 @@ $ mvn verify -Pintegration-testing
[source,options="nowrap"]
----
$ mvn wildfly:shutdown
----
----

Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,15 @@ ifdef::deploymentDir[]
$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams}
----
endif::[]
+
[NOTE]
====
You may also start the bootable jar without Maven, using the `java` command.
[source,subs="attributes+",options="nowrap"]
----
$ java -jar target/{artifactId}-bootable.jar
----
====

. Type the following command to run the integration tests.
+
Expand Down

0 comments on commit e5b4132

Please sign in to comment.