Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Compare: Home

Showing with 12 additions and 12 deletions.
  1. +12 −12 Home.md
View
24 Home.md
@@ -1,12 +1,12 @@
## Introduction
-This document describes a [Maven](http://maven.apache.org) plugin used for uploading and installing artifacts to a running [CRX](http://www.day.com/day/en/products/crx.html) 2.1 or better based application (like Adobe CQ5) using official [CRX API](http://dev.day.com/content/docs/en/crx/current/how_to/package_manager.html#Package%20Manager%20HTTP%20Service%20API). Thanks to that feature, development process can be automated up to the deployment step of final application which makes developer's work more easy. The plugin is able to detect subtle errors (such as xml parsing exception) during package installation. It was tested with CQ 5.4 (CRX 2.2) and therefore it should be tested before using it with other version (mainly due to the detection of errors based on the html parsing).
+This document describes a [Maven](http://maven.apache.org) plugin used for uploading and installing artifacts to a running [CRX](http://www.day.com/day/en/products/crx.html) 2.1 or better based application (like Adobe CQ5) using official [CRX API](http://dev.day.com/content/docs/en/crx/current/how_to/package_manager.html#Package%20Manager%20HTTP%20Service%20API). Thanks to that feature, development process can be automated up to the deployment step of final application which makes developer's work more easy. The plugin is able to detect subtle errors (such as xml parsing exception) during package installation. It was tested with CQ 5.4 (CRX 2.2) and therefore it should be tested before using it with other versions/applications (mainly due to the detection of errors based on the html parsing).
Maven CRX Plugin provides the following goals:
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr><td>crx:upload</td><td>Uploads a selected artifact to a running CRX instance</td></tr>
- <tr><td>crx:install</td><td>Installs previously uploaded artifact in a running CRX instance (invokes {{crx:upload}} goal before running itself)</td></tr>
+ <tr><td>crx:install</td><td>Installs previously uploaded artifact in a running CRX instance (invokes crx:upload goal before running itself)</td></tr>
</table>
## Installation
@@ -27,7 +27,7 @@ Provided that everything went right, plugin is now available for your Maven proj
## Usage
-To use the plugin, add the following definition to your parent {{pom.xml}} and/or in every submodule accordingly:
+To use the plugin, add the following definition to your parent pom.xml and/or in every submodule accordingly:
<build>
<plugins>
@@ -60,7 +60,7 @@ To use the plugin, add the following definition to your parent {{pom.xml}} and/o
</pluginManagement>
</build>
-_It is recommended that you extract the URL, user and password values into a separate properties and store them in the `../.m2/settings.xml` file - so that each developer can have independent configuration(s)_
+_It is recommended that you extract the URL, user and password values into a separate properties and store them in the `~/.m2/settings.xml` file - so that each developer can have independent configuration(s)._
h2. Configuration
@@ -71,18 +71,18 @@ Maven CRX Plugin can be configured using `<configuration>` element (see _Usage_
<tr><td><code>url</code></td><td><code>http://localhost:5402</code></td><td>The URL of the running CRX instance.</td></tr>
<tr><td><code>user</code></td><td><code>admin</code></td><td>The user name to authenticate at the running CRX instance.</td></tr>
<tr><td><code>password</code></td><td><code>admin</code></td><td>The password to authenticate at the running CRX instance.</td></tr>
- <tr><td><code>packageFileName</code></td><td><code>${project.build.directory}/${project.build.finalName}.zip</code></td><td>Artifact file name to be uploaded or/and installed.</td></tr>
- <tr><td><code>force</code></td><td><code>true</code></td><td>Forces plugin to upload artifact even it already exists in the CRX repository.</td></tr>
- <tr><td><code>packageManagerSuffix</code></td><td><code>/crx/packmgr/service</code></td><td>An optional URL suffix which will be appended to the {{url}} for use as the real target URL of package manager. Current default value supports recent version of CRX API so there is no need to change it at the moment.</td></tr>
- <tr><td><code>skip</code></td><td><code>false</code></td><td>Whether to skip this step even though it has been configured in the project to be executed.</td></tr>
+ <tr><td><code>packageFileName</code></td><td><code>${project.build.directory}/${project.build.finalName}.zip</code></td><td>Artifact file name to be uploaded and installed.</td></tr>
+ <tr><td><code>force</code></td><td><code>true</code></td><td>Forces plugin to upload the artifact even there is already one with the same name in CRX repository.</td></tr>
+ <tr><td><code>packageManagerSuffix</code></td><td><code>/crx/packmgr/service</code></td><td>An optional URL suffix which will be appended to the <code>url</code> for use as the real target URL of package manager. Current default value supports recent version of CRX API so there is no need to change it at the moment.</td></tr>
+ <tr><td><code>skip</code></td><td><code>false</code></td><td>Indicates whether to skip this step even though it has been configured in the project to be executed.</td></tr>
</table>
-_Please note that it is always possible to override those parameters from command line by referencing a system property that the user sets via the `-D` option. Every such a parameter should be proceed by a `crx.` prefix,
-i.e.: `mvn ... crx:install \-Dcrx.password=secure`_
+_Please note that it is always possible to override those parameters from command line by referencing a system property that user can provide using `-D` option. Every such a parameter should be proceed by a `crx.` prefix,
+i.e.: `mvn ... crx:install -Dcrx.password=secure`_
## Goal: crx:upload
-The **upload** goal simply uploads specified file to the running instance of CRX repository. In most cases it would be any artifact build by Maven in proceeding goal: a jar file or zip package. Proper file can be selected using `<package.file>` configuration element, i.e.: `<packageFileName>$\{project.build.directory}/$\{project.build.finalName}.zip</packageFileName>`.
+The **upload** goal simply uploads specified file to the running instance of CRX repository. In most cases it would be any artifact build by Maven in proceeding goal: a jar file or zip package. Proper file can be selected using `<package.file>` configuration element, i.e.: `<packageFileName>${project.build.directory}/${project.build.finalName}.zip</packageFileName>`.
### Use
@@ -93,7 +93,7 @@ You can invoke **upload** goal by running following command:
## Goal: crx:install
The **install** goal sends request to running instance of CRX repository to install previously uploaded package. To be properly installed, this should be a valid CRX package.
-Please note that before running this goal, **upload** goal is always being invoked before to ensure that there is a proper package installed already.
+Please note that before running this goal, **upload** goal is always being invoked before to ensure that there is a proper package upoaded already.
### Use
Something went wrong with that request. Please try again.