erlang:generate-release-resources

Full name:

eu.lindenbaum:maven-erlang-plugin:2.2.0:generate-release-resources

Description:

Copies all resource files into that target directory structure. Copied resources contain:
  • release file (*.rel)
  • release upgrade file (relup)
  • boot scripts, etc. as returned from systools:make_script
The build of script files can be customized by passing user options through the scriptOptions parameter. In order to manage the project over the project pom there is the possibility to let the Mojo automatically fill in values from the project pom into the .rel file. This can be done by using one of the supported variables into the release file. Below is a list of supported variables and their substitutions:

  • ${ARTIFACT}: the projects artifact id (string)
  • ${DESCRIPTION}: the projects description string (string)
  • ${ID}: the project id (string)
  • ${NAME}: the projects name (string)
  • ${VERSION}: the projects version (string)
  • ${ERTS}: expands to the tuple {erts, "ERTS_VERSION"} with the version of erts available on the backend node (tuple)
  • ${APPLICATIONS}: a comma separated listing with all transitive dependency applications of the project (tuple listing)
  • ${AUTODEPS}: an erlang list with all transitive dependency applications of the project (list)
  • ${APPLICATION_NAME}: will be replaced by the tuple {'APPLICATION_NAME', "APPLICATION_VERSION"} with the version available on the backend node (tuple)

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: generate-resources.

Optional Parameters

Name Type Since Description
cookie String - The cookie to use for the java and the backend node.
erlCommand String - The erlang command used to start an erlang backend node. The path must exist and the destination must be executable. If the given command does not fullfill these requirements erl is used (assuming the command is part of the hosts PATH). The path must not contain any arguments.
scriptOptions String - Additional options for systools:make_script/2 (comma separated). Note: The silent option is passed by the plugin, do not overwrite.

Parameter Details

cookie:

The cookie to use for the java and the backend node.
  • Type: java.lang.String
  • Required: No
  • Expression: ${cookie}

erlCommand:

The erlang command used to start an erlang backend node. The path must exist and the destination must be executable. If the given command does not fullfill these requirements erl is used (assuming the command is part of the hosts PATH). The path must not contain any arguments.
  • Type: java.lang.String
  • Required: No
  • Expression: ${erlCommand}

scriptOptions:

Additional options for systools:make_script/2 (comma separated). Note: The silent option is passed by the plugin, do not overwrite.
  • Type: java.lang.String
  • Required: No
  • Expression: ${scriptOptions}