opkg:package

Full name:

de.gsi.cs.co.maven.plugins:opkg-maven-plugin:0.0.6:package

Description:

Collect data and control tarball to create the opkg package

The files packaged in the opkg are collected using the maven-assembly-plugin. There are four predefined assembly descriptors available in the opkg-assembly-descriptors artifact.

if you need a more complicated descriptor see the maven assembly descriptor format for a reference and the descriptor configuration element of this goal.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
opkgWorkdir File - Working directory. Advised to not change this as it will break assemblies. Will receive the data and control tarball.
Default value is: ${project.build.directory}/opkg.
project MavenProject - The Maven Project. (to make it accessible from the plugin)
Default value is: ${project}.
session MavenSession - The Session executing this plugin. (to make it accessible from the plugin)
Default value is: ${session}.

Optional Parameters

Name Type Since Description
attach boolean - Attach opkg to build
Default value is: true.
classifier String - Use a classifier on the attached opkg
descriptor String - A string to a file with a maven assembly descriptor
descriptorRef String - A string to a maven assembly descriptor reference.

You only need to specify your own descriptor if the bundled descriptors and their filtering options (excludeHeader, includeDependencies, excludeDependencies) are not sufficient.

They must be defined in a plugin dependency with an artifact name that includes the string assembly or descriptor. for example de.gsi.cs.co.maven.opkg:opkg-assembly-descriptors

The assembly for the opkg will run in a parallel build with a seperate execution environment. Only artifacts that match assembly or descriptor will be available in this parallel build


excludeHeader boolean - If true, all files are filtered to exclude folders named include (assuming they contain headers).
Default value is: false.
includeDependencies boolean - If true, all project dependencies of type zip will be unpacked and included in the opkg.
Default value is: false.
plugin PluginDescriptor - Make PluginDescriptor accessible to the plugin.
Default value is: ${plugin}.
targetArch String - Architecture of the control file. It will default to the property scons.arch, with a fallback to the system property os.arch

Parameter Details

attach:

Attach opkg to build
  • Type: boolean
  • Required: No
  • Default: true

classifier:

Use a classifier on the attached opkg
  • Type: java.lang.String
  • Required: No

descriptor:

A string to a file with a maven assembly descriptor
  • Type: java.lang.String
  • Required: No

descriptorRef:

A string to a maven assembly descriptor reference.

You only need to specify your own descriptor if the bundled descriptors and their filtering options (excludeHeader, includeDependencies, excludeDependencies) are not sufficient.

They must be defined in a plugin dependency with an artifact name that includes the string assembly or descriptor. for example de.gsi.cs.co.maven.opkg:opkg-assembly-descriptors

The assembly for the opkg will run in a parallel build with a seperate execution environment. Only artifacts that match assembly or descriptor will be available in this parallel build

  • Type: java.lang.String
  • Required: No

excludeHeader:

If true, all files are filtered to exclude folders named include (assuming they contain headers).
  • Type: boolean
  • Required: No
  • Default: false

includeDependencies:

If true, all project dependencies of type zip will be unpacked and included in the opkg.
  • Type: boolean
  • Required: No
  • Default: false

opkgWorkdir:

Working directory. Advised to not change this as it will break assemblies. Will receive the data and control tarball.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/opkg

plugin:

Make PluginDescriptor accessible to the plugin.
  • Type: org.apache.maven.plugin.descriptor.PluginDescriptor
  • Required: No
  • Default: ${plugin}

project:

The Maven Project. (to make it accessible from the plugin)
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • Default: ${project}

session:

The Session executing this plugin. (to make it accessible from the plugin)
  • Type: org.apache.maven.execution.MavenSession
  • Required: Yes
  • Default: ${session}

targetArch:

Architecture of the control file. It will default to the property scons.arch, with a fallback to the system property os.arch
  • Type: java.lang.String
  • Required: No