Merge pull request #1649 from cherylking/fixDocsAndComponentsXml

Fix multiple doc issues and missing groupId in components.xml
OpenLiberty · Mar 22, 2023 · 36df763 · 36df763
2 parents a6533a6 + 5c6ead4
commit 36df763
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -112,7 +112,27 @@ Example using the `runtimeArtifact` parameter to install a WebSphere Liberty run
         <runtimeArtifact>
             <groupId>com.ibm.websphere.appserver.runtime</groupId>
             <artifactId>wlp-webProfile8</artifactId>
-            <version>22.0.0.12</version>
+            <version>23.0.0.2</version>
+            <type>zip</type>
+        </runtimeArtifact>
+    </configuration>
+</plugin>
+```
+
+To install an Open Liberty beta runtime, specify the `runtimeArtifact` with the `io.openliberty.beta` groupId, `open liberty-runtime` artifactId and the `version` that is needed.
+
+Example using the `runtimeArtifact` parameter to install an Open Liberty beta runtime from a Maven artifact:
+
+```xml
+<plugin>
+    <groupId>io.openliberty.tools</groupId>
+    <artifactId>liberty-maven-plugin</artifactId>
+    <version>3.7.1</version>
+    <configuration>
+        <runtimeArtifact>
+            <groupId>io.openliberty.beta</groupId>
+            <artifactId>openliberty-runtime</artifactId>
+            <version>23.0.0.3-beta</version>
             <type>zip</type>
         </runtimeArtifact>
     </configuration>

diff --git a/docs/common-parameters.md b/docs/common-parameters.md
@@ -13,7 +13,7 @@ Parameters shared by all goals.
 | install | Install Liberty runtime from the [Liberty repository](installation-configuration.md#using-the-install-liberty-ant-task). | Yes, only when `installDirectory`, `runtimeArchive`, and `runtimeArtifact` parameters are not set. |
 | licenseArtifact | Maven artifact name of the Liberty license jar. It will be used to upgrade the installation at the location specified by the `runtimeInstallDirectory` parameter. | No |
 | serverName | Name of the Liberty server instance. The default value is `defaultServer`. | No |
-| userDirectory | Alternative user directory location that contains server definitions and shared resources (`WLP_USER_DIR`). | No |
+| userDirectory | Alternative user directory location that contains server definitions and shared resources. The default value is `usr` located in the Liberty runtime installation directory. | No |
 | outputDirectory | Alternative location for server generated output such as logs, the _workarea_ directory, and other generated files (`WLP_OUTPUT_DIR`). The default value for the `package` and `install-feature` goals is `${project.build.directory}/liberty-alt-output-dir`. | No |
 | runtimeInstallDirectory | Local installation directory location of the Liberty server when the server is installed using the runtime archive, runtime artifact or repository option. The default value is `${project.build.directory}/liberty`.  | No |
 | refresh | If true, re-install Liberty server into the local directory. This is only used when when the server is installed using the runtime archive or runtime artifact option. The default value is false. | No |

diff --git a/docs/deploy.md b/docs/deploy.md
@@ -10,7 +10,7 @@ The following are the parameters supported by this goal in addition to the [comm
 | --------  | ----------- | -------  |
 | appsDirectory | The server's `apps` or `dropins` directory where the application files should be copied. The default value is set to `apps` if the application is defined in the server configuration, otherwise it is set to `dropins`.  | No |
 | copyLibsDirectory | The optional directory to which loose application dependencies referenced by the loose application configuration file are copied. For example, if you want loose application dependencies to be contained within the build directory, you could set this parameter to `target`. The loose application configuration file will reference this directory for the loose application dependencies instead of the local repository cache. Only applicable when `looseApplication` is set to `true`. | No |
-| deployPackages | The Maven packages to copy to Liberty runtime's application directory. One of `dependencies`, `project` or `all`. The default is `project`.<br>For an ear type project, this parameter is ignored and only the project package is installed. | No |
+| deployPackages | The Maven packages to copy to Liberty runtime's application directory. One of `dependencies`, `project`, `spring-boot-project` or `all`. The default is `project`.<br>For an ear type project, this parameter is ignored and only the project package is installed. | No |
 | looseApplication | Generate a loose application configuration file representing the Maven project package and copy it to the Liberty server's `apps` or `dropins` directory. The default value is `true`. This parameter is ignored if `deployPackages` is set to `dependencies` or if the project packaging type is neither `war` nor `liberty-assembly`. When using the packaging type `liberty-assembly`, using a combination of `deployPackages` set to `all` or `project` and `looseApplication` set to `true` results in the installation of application code provided in the project without the need of adding additional goals to your POM file. | No |
 | stripVersion | Strip artifact version when copying the application to Liberty runtime's application directory. The default value is `false`. | No |
 | timeout | Maximum time to wait (in seconds) to verify that the deployment has completed successfully. The default value is 40 seconds. | No |

diff --git a/docs/installation-configuration.md b/docs/installation-configuration.md
@@ -8,6 +8,7 @@ The Maven Central repository includes the following Liberty runtime artifacts. V
 
 | Group ID : Artifact ID | Description |
 | ---------------------- | ----------- |
+| [`io.openliberty:openliberty-kernel`](https://repo1.maven.org/maven2/io/openliberty/openliberty-kernel/)  | Open Liberty runtime kernel. |
 | [`io.openliberty:openliberty-runtime`](https://repo1.maven.org/maven2/io/openliberty/openliberty-runtime/)  | Open Liberty runtime. |
 | [`io.openliberty:openliberty-jakartaee9`](https://repo1.maven.org/maven2/io/openliberty/openliberty-jakartaee9/)  | Open Liberty runtime with all Jakarta EE 9 features. |
 | [`io.openliberty:openliberty-javaee8`](https://repo1.maven.org/maven2/io/openliberty/openliberty-javaee8/)  | Open Liberty runtime with all Java EE 8 Full Platform features. |
@@ -16,7 +17,7 @@ The Maven Central repository includes the following Liberty runtime artifacts. V
 | [`io.openliberty:openliberty-microProfile5`](https://repo1.maven.org/maven2/io/openliberty/openliberty-microProfile5/)  | Open Liberty runtime with features for a MicroProfile 5 runtime. |
 | [`io.openliberty:openliberty-microProfile4`](https://repo1.maven.org/maven2/io/openliberty/openliberty-microProfile4/)  | Open Liberty runtime with features for a MicroProfile 4 runtime. |
 | [`io.openliberty:openliberty-microProfile3`](https://repo1.maven.org/maven2/io/openliberty/openliberty-microProfile3/)  | Open Liberty runtime with features for a MicroProfile 3 runtime. |
-| [`io.openliberty:openliberty-kernel`](https://repo1.maven.org/maven2/io/openliberty/openliberty-kernel/)  | Open Liberty runtime kernel. |
+| [`io.openliberty.beta:openliberty-runtime `](https://repo1.maven.org/maven2/io/openliberty/beta/openliberty-runtime/)  | Open Liberty runtime beta. |
 | [`com.ibm.websphere.appserver.runtime:wlp-jakartaee9`](https://repo1.maven.org/maven2/com/ibm/websphere/appserver/runtime/wlp-jakartaee9/)  | WebSphere Liberty runtime with all Jakarta EE 9 features. |
 | [`com.ibm.websphere.appserver.runtime:wlp-javaee8`](https://repo1.maven.org/maven2/com/ibm/websphere/appserver/runtime/wlp-javaee8/)  | WebSphere Liberty runtime with all Java EE 8 Full Platform features. |
 | [`com.ibm.websphere.appserver.runtime:wlp-javaee7`](https://repo1.maven.org/maven2/com/ibm/websphere/appserver/runtime/wlp-javaee7/)  | WebSphere Liberty runtime with all Java EE 7 Full Platform features. |

diff --git a/docs/spring-boot-support.md b/docs/spring-boot-support.md
@@ -3,14 +3,14 @@ The `liberty-maven-plugin` provides support for Spring Boot applications, allowi
 
 ### Additional Parameters
 
-When installing a Spring Boot application via the Spring Boot executable JAR, the following are the parameters supported by the `install-apps` goal in addition to the [common server parameters](common-server-parameters.md#common-server-parameters) and the [common parameters](common-parameters.md#common-parameters).
+When installing a Spring Boot application via the Spring Boot executable JAR, the following are the parameters supported by the `deploy` goal in addition to the [common server parameters](common-server-parameters.md#common-server-parameters) and the [common parameters](common-parameters.md#common-parameters).
 
 | Parameter | Description | Required |
 | --------  | ----------- | -------  |
 | appsDirectory | The server's `apps` or `dropins` directory where the application files should be copied. The default value is set to `apps` if the application is defined in the server configuration, otherwise it is set to `dropins`.  | No |
-| deployPackages | The Maven packages to copy to Liberty runtime's application directory. `spring-boot-project` should be configured to this parameter. | Yes |
+| deployPackages | The Maven packages to copy to Liberty runtime's application directory. This parameter should be set to `spring-boot-project`. | Yes |
 
-The `server.xml` provided by the `serverXml` parameter should enable the one of the following Spring Boot features.
+The `server.xml` provided by the `serverXmlFile` parameter or located in the `configDirectory` should enable the one of the following Spring Boot features.
 
 | Feature | Description |
 | ------- | ----------- |
@@ -36,7 +36,7 @@ To use the `liberty-maven-plugin` to install a Spring Boot application packaged
                     <id>install-apps</id>
                     <phase>pre-integration-test</phase>
                     <goals>
-                        <goal>install-apps</goal>
+                        <goal>deploy</goal>
                     </goals>
                     <configuration>
                         <appsDirectory>apps</appsDirectory>

diff --git a/liberty-maven-plugin/src/main/resources/META-INF/plexus/components.xml b/liberty-maven-plugin/src/main/resources/META-INF/plexus/components.xml
@@ -39,10 +39,10 @@
                                 org.apache.maven.plugins:maven-surefire-plugin:test
                             </test>
                             <prepare-package>
-                                :liberty-maven-plugin:install-server,
+                                io.openliberty.tools:liberty-maven-plugin:install-server,
                                 io.openliberty.tools:liberty-maven-plugin:create,
-								io.openliberty.tools:liberty-maven-plugin:prepare-feature,
-                                io.openliberty.tools:liberty-maven-plugin:install-feature,
+				io.openliberty.tools:liberty-maven-plugin:prepare-feature,
+                                io.openliberty.tools:liberty-maven-plugin:install-feature
                             </prepare-package>
                             <package>
                                 io.openliberty.tools:liberty-maven-plugin:deploy,