You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by rz...@apache.org on 2022/01/17 11:57:42 UTC
[tomee] branch master updated: Minor: Updates TomEE Maven Plugin related documentation
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomee.git
The following commit(s) were added to refs/heads/master by this push:
new f745be5 Minor: Updates TomEE Maven Plugin related documentation
f745be5 is described below
commit f745be5ac75065e0617b60b31e2dd2bef9f9e836
Author: Richard Zowalla <rz...@apache.org>
AuthorDate: Mon Jan 17 12:57:10 2022 +0100
Minor: Updates TomEE Maven Plugin related documentation
---
docs/developer/tools/maven-plugins.adoc | 2 +-
docs/developer/tools/maven/tomee.adoc | 5 +-
docs/maven/index.adoc | 93 +++++++++++----------------------
docs/tomee-maven-plugin.adoc | 93 +++++++++++----------------------
docs/tomee-mp-getting-started.adoc | 2 +-
5 files changed, 65 insertions(+), 130 deletions(-)
diff --git a/docs/developer/tools/maven-plugins.adoc b/docs/developer/tools/maven-plugins.adoc
index 4216b31..66692dd 100644
--- a/docs/developer/tools/maven-plugins.adoc
+++ b/docs/developer/tools/maven-plugins.adoc
@@ -1,4 +1,4 @@
-= TomEE Maven Plugins
+= TomEE Maven Plugins - Introduction
:index-group: TomEE Maven Plugin
:jbake-date: 2016-03-16
:jbake-type: page
diff --git a/docs/developer/tools/maven/tomee.adoc b/docs/developer/tools/maven/tomee.adoc
index c5f4693..5a4fd75 100644
--- a/docs/developer/tools/maven/tomee.adoc
+++ b/docs/developer/tools/maven/tomee.adoc
@@ -1,4 +1,4 @@
-= TomEE Maven Plugin
+= TomEE Maven Plugin - Goals & Configuration
:index-group: TomEE Maven Plugin
:jbake-date: 2016-03-16
:jbake-type: page
@@ -82,6 +82,7 @@ The most commonly used goal, it allows to start a tomee with applications. Here
|tomeeAlreadyInstalled|false|skip all the setup configuration
|ejbRemote|true|should EJBd be activated
|checkStarted|false|should the plugin check the server is up (useful when used with `pre-integration` phase
+|checkStartedAttempts|60| only active, if `checkStarted` is set to `true`. Specifies amount of connection attempts (active waiting) for the server to be up
|useConsole|true|wait for the end of the execution reading inputs from the console (like `quit` command)
|useOpenEJB|false|use openejb-standalone instead of tomee
|inlinedServerXml|-|a server.xml content in pom.xml directly
@@ -140,7 +141,7 @@ remove:prefix
<plugin>
<groupId>org.apache.tomee.maven</groupId>
<artifactId>tomee-maven-plugin</artifactId>
- <version>${tomee7.version}</version>
+ <version>8.0.9</version>
<configuration>
<tomeeClassifier>plus</tomeeClassifier>
<debug>false</debug>
diff --git a/docs/maven/index.adoc b/docs/maven/index.adoc
index 43ee09b..7c00327 100644
--- a/docs/maven/index.adoc
+++ b/docs/maven/index.adoc
@@ -1,4 +1,4 @@
-= TomEE Maven Plugin
+= TomEE Maven Plugin - Configuration
:index-group: TomEE Maven Plugin
:jbake-date: 2018-12-05
:jbake-type: page
@@ -12,18 +12,18 @@ feature-rich plugin that allows for:
* Server start and stop
* Application deployment and undeployment
-Simply add the following to the , and optionally the ), section of your
+Simply add the following to the `<plugins>` and optionally the `<pluginManagement>` section of your
`pom.xml`
[source,xml]
----
<plugins>
<plugin>
- <groupId>org.apache.openejb.maven</groupId>
+ <groupId>org.apache.tomee.maven</groupId>
<artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
+ <version>8.0.9</version>
<configuration>
- <tomeeVersion>1.7.1</tomeeVersion>
+ <tomeeVersion>8.0.9</tomeeVersion>
<tomeeClassifier>plus</tomeeClassifier>
</configuration>
</plugin>
@@ -32,67 +32,36 @@ Simply add the following to the , and optionally the ), section of your
== Plugin Goals
-Goal
-Description
-
-tomee:build
-
-Create TomEE, but do not run it.
-
-tomee:configtest
-
-Run the Apache Tomcat `configtest` command.
-
-tomee:debug
-
-Same as `run` but with debug activated on the default or specified port.
-
-tomee:deploy
-
-Deploy an application in a running TomEE.
-
-tomee:exec
-
-Undocumented.
-
-tomee:help
-
-Display help information on the tomee-maven-plugin. Call mvn tomee:help
+[.table.table-bordered,options="header"]
+|===
+| Goal | Description
+| tomee:build | Create TomEE, but do not run it.
+| tomee:configtest| Run the Apache Tomcat `configtest` command.
+| tomee:debug | Same as `run` but with debug activated on the default or specified port.
+| tomee:deploy | Deploy an application in a running TomEE.
+| tomee:exec | Creates an executable jar of the application.
+| tomee:help | Display help information on the tomee-maven-plugin. Call mvn tomee:help
-Ddetail=true -Dgoal=<goal-name> to display parameter details.
-
-tomee:list
-
-Largely inspired by the OpenEJB command helper, but with some
+| tomee:list | Largely inspired by the OpenEJB command helper, but with some
differences. List deployed EJB's in a running TomEE.
+| tomee:run |Start and wait for TomEE.
+| tomee:start | Start TomEE and continue.
+| tomee:stop | Stop a TomEE started with start command.
+| tomee:undeploy | Undeploy an application in a running TomEE
+|===
-tomee:run
-
-Start and wait for TomEE.
-
-tomee:start
-
-Start TomEE and continue.
-
-tomee:stop
-
-Stop a TomEE started with start command.
-
-tomee:undeploy
-
-Undeploy an application in a running TomEE
-
-Note that for the tomee:deploy and tomee:undeploy goals, the path can
+**Note 1:** For `tomee:deploy` and `tomee:undeploy` goals, the path can
either be specified within the section of the `pom.xml` using the
parameter, or it can be passed via the user property
tomee-plugin.archive. If a relative path is passed for the deploy path
archive, this must be relative to the TomEE server.
-Note 2: running tomee maven plugin you can type 'quit' directly in the
-console to shutdown correctly the server. 'reload' is also available
+**Note 2**: While running TomEE Maven Plugin, you can type `quit` directly in the
+console to shutdown the server correctly. `reload` is also available
when internal openejb application is deployed.
-###More Tweaks
+### More Tweaks
The lib tag allows to enrich the container with some additional
libraries.
@@ -107,7 +76,7 @@ with the specified prefix
Note: the name tweak can be used to rename applications too
-###Provisioning Example
+### Provisioning Example
This plugin is also usable in projects which are not war. For instance
you can use it in a pom project to setup a TomEE install, add libraries,
@@ -118,9 +87,9 @@ deploy apps then run the server.
<plugin>
<groupId>org.apache.openejb.maven</groupId>
<artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
+ <version>8.0.9</version>
<configuration>
- <tomeeVersion>1.7.1</tomeeVersion>
+ <tomeeVersion>8.0.9</tomeeVersion>
<tomeeClassifier>plus</tomeeClassifier>
<debug>false</debug>
<debugPort>5005</debugPort>
@@ -145,14 +114,14 @@ deploy apps then run the server.
</plugin>
----
-###Auto Reloading Example
+### Auto Reloading Example
[source,xml]
----
<plugin>
<groupId>org.apache.openejb.maven</groupId>
<artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
+ <version>8.0.9</version>
<configuration>
<synchronization>
<extensions>
@@ -173,6 +142,4 @@ The Synchronization block supports the following configuration options:
* updateInterval (default 5 - in second)
* extensions (default html, xhtml, js and css)
* regex: a regex should match files to take into account when updating
-
-reloadOnUpdate means to reload the entire context (webapp). This means
-undeploying/redeploying the application.
+* reloadOnUpdate means to reload the entire context (webapp), i.e. undeploying/redeploying the application.
\ No newline at end of file
diff --git a/docs/tomee-maven-plugin.adoc b/docs/tomee-maven-plugin.adoc
index 580158c..99b6818 100644
--- a/docs/tomee-maven-plugin.adoc
+++ b/docs/tomee-maven-plugin.adoc
@@ -1,4 +1,4 @@
-= TomEE Maven Plugin
+= TomEE Maven Plugin - Configuration
:index-group: Unrevised
:jbake-date: 2018-12-05
:jbake-type: page
@@ -12,18 +12,18 @@ feature-rich plugin that allows for:
* Server start and stop
* Application deployment and undeployment
-Simply add the following to the `<plugins>`, and optionally the `<pluginManagement>`), section of your
+Simply add the following to the `<plugins>` and optionally the `<pluginManagement>` section of your
`pom.xml`
[source,xml]
----
<plugins>
<plugin>
- <groupId>org.apache.openejb.maven</groupId>
+ <groupId>org.apache.tomee.maven</groupId>
<artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
+ <version>8.0.9</version>
<configuration>
- <tomeeVersion>1.7.1</tomeeVersion>
+ <tomeeVersion>8.0.9</tomeeVersion>
<tomeeClassifier>plus</tomeeClassifier>
</configuration>
</plugin>
@@ -32,67 +32,36 @@ Simply add the following to the `<plugins>`, and optionally the `<pluginManageme
== Plugin Goals
-Goal
-Description
-
-tomee:build
-
-Create TomEE, but do not run it.
-
-tomee:configtest
-
-Run the Apache Tomcat `configtest` command.
-
-tomee:debug
-
-Same as `run` but with debug activated on the default or specified port.
-
-tomee:deploy
-
-Deploy an application in a running TomEE.
-
-tomee:exec
-
-Creates an executable jar of the application.
-
-tomee:help
-
-Display help information on the tomee-maven-plugin. Call mvn tomee:help
+[.table.table-bordered,options="header"]
+|===
+| Goal | Description
+| tomee:build | Create TomEE, but do not run it.
+| tomee:configtest| Run the Apache Tomcat `configtest` command.
+| tomee:debug | Same as `run` but with debug activated on the default or specified port.
+| tomee:deploy | Deploy an application in a running TomEE.
+| tomee:exec | Creates an executable jar of the application.
+| tomee:help | Display help information on the tomee-maven-plugin. Call mvn tomee:help
-Ddetail=true -Dgoal=<goal-name> to display parameter details.
-
-tomee:list
-
-Largely inspired by the OpenEJB command helper, but with some
+| tomee:list | Largely inspired by the OpenEJB command helper, but with some
differences. List deployed EJB's in a running TomEE.
+| tomee:run |Start and wait for TomEE.
+| tomee:start | Start TomEE and continue.
+| tomee:stop | Stop a TomEE started with start command.
+| tomee:undeploy | Undeploy an application in a running TomEE
+|===
-tomee:run
-
-Start and wait for TomEE.
-
-tomee:start
-
-Start TomEE and continue.
-
-tomee:stop
-
-Stop a TomEE started with start command.
-
-tomee:undeploy
-
-Undeploy an application in a running TomEE
-
-Note that for the tomee:deploy and tomee:undeploy goals, the path can
+**Note 1:** For `tomee:deploy` and `tomee:undeploy` goals, the path can
either be specified within the section of the `pom.xml` using the
parameter, or it can be passed via the user property
tomee-plugin.archive. If a relative path is passed for the deploy path
archive, this must be relative to the TomEE server.
-Note 2: running tomee maven plugin you can type 'quit' directly in the
-console to shutdown correctly the server. 'reload' is also available
+**Note 2**: While running TomEE Maven Plugin, you can type `quit` directly in the
+console to shutdown the server correctly. `reload` is also available
when internal openejb application is deployed.
-###More Tweaks
+### More Tweaks
The lib tag allows to enrich the container with some additional
libraries.
@@ -107,7 +76,7 @@ with the specified prefix
Note: the name tweak can be used to rename applications too
-###Provisioning Example
+### Provisioning Example
This plugin is also usable in projects which are not war. For instance
you can use it in a pom project to setup a TomEE install, add libraries,
@@ -118,9 +87,9 @@ deploy apps then run the server.
<plugin>
<groupId>org.apache.openejb.maven</groupId>
<artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
+ <version>8.0.9</version>
<configuration>
- <tomeeVersion>1.7.1</tomeeVersion>
+ <tomeeVersion>8.0.9</tomeeVersion>
<tomeeClassifier>plus</tomeeClassifier>
<debug>false</debug>
<debugPort>5005</debugPort>
@@ -145,14 +114,14 @@ deploy apps then run the server.
</plugin>
----
-###Auto Reloading Example
+### Auto Reloading Example
[source,xml]
----
<plugin>
<groupId>org.apache.openejb.maven</groupId>
<artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
+ <version>8.0.9</version>
<configuration>
<synchronization>
<extensions>
@@ -173,6 +142,4 @@ The Synchronization block supports the following configuration options:
* updateInterval (default 5 - in second)
* extensions (default html, xhtml, js and css)
* regex: a regex should match files to take into account when updating
-
-reloadOnUpdate means to reload the entire context (webapp). This means
-undeploying/redeploying the application.
+* reloadOnUpdate means to reload the entire context (webapp), i.e. undeploying/redeploying the application.
diff --git a/docs/tomee-mp-getting-started.adoc b/docs/tomee-mp-getting-started.adoc
index 646be4f..396c822 100644
--- a/docs/tomee-mp-getting-started.adoc
+++ b/docs/tomee-mp-getting-started.adoc
@@ -1,4 +1,4 @@
-= TomEE Maven Plugin
+= TomEE Maven Plugin - Getting Started
:index-group: TomEE Maven Plugin
:jbake-date: 2018-12-05
:jbake-type: page