Versions Compared

Old Version 15

changes.mady.by.user Daniel Keir Haywood

Saved on

compared with

New Version Current

changes.mady.by.user Daniel Keir Haywood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

Note: if you just want to try out Isis then there's no need to built it first; just use our quickstart maven archetype

...

Introduction

The following assumes that you've set up your development environment; see SettingUpDevelopmentEnvironment if not.

...

Maven Profiles

-D modules=

applib

core

defaults

runtimes

progmodel

profilestores

securityalternatives

viewer

release

support

release

examples

site-skin

clean install?

-D build=full?

site-deploy?

-D site=full?

Description

standard

Y

Y

Y

Y

Y

Y

Y

 

 

 

 

Y  

Y

Y

Y

The standard set for a smoke test; if this builds we're probably ok. In fact, are also modules that make up the site, ie mvn site-deploy

all

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

 

 

 

Every module that can be built using mvn clean install. Can't necessarily be deployed, though; see 'Deployability' section below

skin

 

 

 

 

 

 

 

 

 

 

Y

Y

Y

 

 

Prereq for running site-deploy

applib

Y

 

 

 

 

 

 

 

 

 

 

Y

Y

Y

Y

Just the applib module

core

 

Y

 

 

 

 

 

 

 

 

 

Y

Y

Y

Y

Just the core modules

runtimes

 

 

Y

 

 

 

 

 

 

 

 

Y

Y

Y

Y

Just the runtime implementations

progmodel

  defaults

 

 

Y

 

 

 

 

 

 

 

Y

Y

Y

Y

Just the defaults modules progmodel implementations

profilestores

  alternatives

 

 

 

Y

 

 

 

 

 

 

Y

Y

Y

Y

Just the alternatives modules profilestore implementations

security

  viewers

 

 

 

 

Y

 

 

 

 

 

Y

Y

Y

Y

Just the viewer modules. viewer security implementations

viewers

 

 

 

 

 

 

Y

 

 

 

 

Y

Y

Y

Y

Just the viewer modules. Added for convenience

release

 

  support

 

 

 

 

 

Y

 

 

 

Y

Y

Y

Y

Just the support release modules.

support

 

  release

 

 

 

 

 

 

Y

 

 

Y

 

 

 

Just the release support modules.

examples

 

 

 

 

 

 

 

 

 

Y

 

Y

Y

 

 

Just the examples modules.

Notes:

  • most profiles that support mvn clean install also support -D build=full (basically, also builds Javadoc JARs). The exception is any profile that includes the 'release' module (we hit problems building javadoc for 'release'; it also doesn't really make sense).
  • similarly, most profiles supporting mvn site-deploy also support -D site=full (basically, full reports, Javadoc, JXR, metrics, code coverage etc). The exception again is those profiles including 'release'
  • the prereqs to building the site are (a) to build the skin, and (b) to install the JIMI package into the local repo using mvn install:install-file -D groupId=com.java -D artifactId=jimi -D version=1.0 -D packaging=jar -D file=/path/to/file
  • running site-deploy also requires specifying where to deploy to. To deploy locally, use -D deploy=local, which will deploy to /tmp/m2-sites/isis.

Typical Use Cases

The first time you run these, you'll need to omit the -o (offline) flag in order to download plugins and dependencies. Thereafter though the -o flag is strongly recommended!

Use case

Command

Quick build

mvn clean install -o

Build 'release' module (prereq for example apps)

mvn clean install -Dmodules=release -o

Build everything

mvn clean install -D modules=all -o

Site skin (prereq to building sites)

mvn clean install -D modules=skin

Quick build of site + docs, deploy locally

mvn site-deploy -D modules=standard -D deploy=local -o

Full build of site + docs, deploy locally

mvn site-deploy -D modules=standard -D site=full -D deploy=local -o

Quick build + site + docs for single module (eg, applib)

mvn clean install site-deploy -D modules=applib -D deploy=local -o

...