opkg:generate

Full name:

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

Description:

Generates the OPKG Package control header

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: generate-sources.

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.
packageName String - The opkg Package Name
Default value is: ${project.artifactId}.
priority String - The installation Priority. Of no real use in opkg as it is not evaluated. Values extra, optional, standard, important, required. See also debian http://www.debian.org/doc/debian-policy/ch-archive.html
Default value is: optional.
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
autoDependencies boolean - Use maven dependencies to fill in dependencies. This will only add dependencies on Maven packaging type opkg or zip. Be careful in many cases you will end up in too many dependencies.
Default value is: false.
dependencies String[] - List of OPKG Dependencies. Specified as name or name (version). for example "devman_i386 (>= 2.3.4)" will require a devman_i386 opkg with a version greater or equal 2.3.4. See also debian http://www.debian.org/doc/debian-policy/ch-relationships.html
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


exactVersion boolean - Use the exact version of maven dependencies during autoDependencies.
Default value is: false.
excludeDependencies String[] - Maven dependencies that should be filtered when generating autoDependencies. This is a glob matched against the artifactid
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}.
provides String - Virtual Provide for the opkg. Useful if a package renaming happened.
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

autoDependencies:

Use maven dependencies to fill in dependencies. This will only add dependencies on Maven packaging type opkg or zip. Be careful in many cases you will end up in too many dependencies.
  • Type: boolean
  • Required: No
  • Default: false

dependencies:

List of OPKG Dependencies. Specified as name or name (version). for example "devman_i386 (>= 2.3.4)" will require a devman_i386 opkg with a version greater or equal 2.3.4. See also debian http://www.debian.org/doc/debian-policy/ch-relationships.html
  • 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

exactVersion:

Use the exact version of maven dependencies during autoDependencies.
  • Type: boolean
  • Required: No
  • Default: false

excludeDependencies:

Maven dependencies that should be filtered when generating autoDependencies. This is a glob matched against the artifactid
  • 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

packageName:

The opkg Package Name
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.artifactId}

plugin:

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

priority:

The installation Priority. Of no real use in opkg as it is not evaluated. Values extra, optional, standard, important, required. See also debian http://www.debian.org/doc/debian-policy/ch-archive.html
  • Type: java.lang.String
  • Required: Yes
  • Default: optional

project:

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

provides:

Virtual Provide for the opkg. Useful if a package renaming happened.
  • Type: java.lang.String
  • Required: No

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