eu.lindenbaum.maven.mojo
Class Setup

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      eu.lindenbaum.maven.ErlangMojo
          eu.lindenbaum.maven.mojo.Setup

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class Setup
extends ErlangMojo

Utility goal that will setup a new Erlang/OTP Maven project, creating the basic resources and folders required, from a best practice point of view.

This will typically replace the functionality given by a Maven archetype, checking and creating any missing resource. Regarding erlang/OTP applications this could be:

• source folder
• application resource file [artifactId].app
• application upgrade file [artifactId].appup
• include folder
• priv folder
• test source folder
• test include folder
• test priv folder

Regarding erlang/OTP releases this could be:

• release file [artifactId].rel
• system configuration sys.config

By default some extras for project management are also generated:

• site folder with site.xml
• apt source folder with index.apt[.vm]
• changelog folder with changes.xml

The default application resource file will look like (this would be sufficient for library applications):

 {application, ${ARTIFACT},
  [{description, ${DESCRIPTION}},
   {id, ${ID}},
    {vsn, ${VERSION}},
    {modules, ${MODULES}},
    {maxT, infinity},
    {registered, ${REGISTERED}},
    {included_applications, []},
    {applications, [kernel, stdlib]},
    {env, []}, 
    {start_phases, []}]}.
 

The default application upgrade file will look like:

 {${VERSION}, [EDIT HERE], [EDIT HERE]}.
 

The default release file will look like:

 {release,
  {${ARTIFACT}, ${VERSION}},
  ${ERTS},
  ${AUTODEPS}}.
 

The default release upgrade file will look like:

 {${VERSION}, [EDIT HERE], [EDIT HERE]}.
 

The default system configuration file will look like:

 [].
 

Author:

Olle Törnström , Tobias Schlager

Goal:

setup

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Setup()

Method Summary

protected void

execute(org.apache.maven.plugin.logging.Log log, Properties p) Will be invoked when ErlangMojo.execute() gets invoked on the base class.

Methods inherited from class eu.lindenbaum.maven.ErlangMojo

execute

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Setup

public Setup()

Method Detail

execute

protected void execute(org.apache.maven.plugin.logging.Log log,
                       Properties p)
                throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: ErlangMojo

Will be invoked when ErlangMojo.execute() gets invoked on the base class.

Specified by:

execute in class ErlangMojo

Parameters:

log - logger to be used for output logging

p - to be passed by the base class.

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

Mojo.execute()