README.md

eXo platform add-ons manager

DESCRIPTION

Command line tool for eXo platform 4.x to install/uninstall add-ons

LICENSE

LGPLv3

SYSTEM REQUIREMENTS

• Java 6+ (Build & Run)
• Apache Maven 3.0.4+ (Build)
• eXo platform 4.0.0+ (Run)

RESOURCES

• Issues Tracker
• Continuous Integration Job (Unit tests + deployment in maven repository)
• Integration Tests Validation Job
• Reporting Job (Sonar + Maven website)
• Sonar Quality dashboard
• Maven website
• Maven artifacts
  • Snapshots
  • Releases
• Specifications

QUICKSTART

git clone [email protected]:exoplatform/addons-manager.git && mvn package

Unpack the content of the generated archive target/addons-manager-VERSION.zip into you eXo platform installation directory and then use the script addon.bat on windows systems and addon on linux/unix systems.

Usage

We are using addon in our samples. If you are on a windows system, just use addon.bat instead.

Display all available addons :

addon list

Display all available addons including development versions (snapshots) :

addon list --snapshots

Display all available addons including unstable versions (alpha, beta, ...) :

addon list --unstable

Display all installed addons in your platform server :

addon list --installed

Display all installed addons with an existing more recent stable version :

addon list --outdated

Display all installed addons with an existing more recent stable or snapshot version :

addon list --outdated  --snapshots

Display all installed addons with an existing more recent stable or unstable version :

addon list --outdated --unstable

Install the latest stable version of the add-on foo

addon install foo

Install the latest stable or development version of the add-on foo

addon install foo --snapshots

Install the latest stable or unstable version of the add-on foo

addon install foo --unstable

Install the version 42.0 of the add-on foo

addon install foo:42.0

Enforce to reinstall the latest stable version of the add-on foo

addon install foo --force

Uninstall the add-on foo

addon uninstall foo

BUILD (AND AUTOMATED TESTS)

To build the project you launch

mvn verify

You can additionally activate the execution of integration tests with

mvn verify -Prun-its

To deactivate all automated tests

mvn verify -DskipTests