Skip to content

Liferay portal

Julien Castelain edited this page Nov 26, 2019 · 1 revision

This document describes how to setup and use alloyeditor for development in liferay-portal

Setting up alloyeditor in liferay-portal

  1. Make sure your master branch is up to date with upstream
git pull upstream master
  1. Install the dependencies with yarn

  2. Work on your local changes

  3. Build a new release of alloyeditor with yarn build

  4. Link the new release with yarn link

    Additionally can inspect the ~/.config/yarn/link (on Linux/macOS) or %APPDATA%\Local\Yarn\Data\link (on Windows) directory to make sure the symbolic link was created.

Now, you can update the alloyeditor package in liferay-portal:

  1. Navigate to the frontend-editor-alloyeditor-web module
  2. Link latest alloyeditor with yarn link alloyeditor
  3. Deploy the module with gradlew deploy

Developing alloyeditor in liferay-portal

Make sure you've setup everything correctly, as indicated in the previous step.

  1. Work on your local changes
  2. Build a new release of alloyeditor with yarn build
  3. Make sure alloyeditor is linked correctly.

You can now update alloyeditor in liferay-portal:

  1. Re-deploy the frontend-editor-alloyeditor-web module with gradlew deploy

Updating alloyeditor's version in liferay-portal

To update alloyeditor's version in liferay-portal:

  1. Navigate to the frontend-editor-alloyeditor-web module
  2. Update the alloyeditor dependency in the package.json file
  3. Re-deploy the module with gradlew clean deploy.

An example can be seen in this commit (package.json file)