yamcs:bundle¶

Bundle a Yamcs application into a single archive file.

Attributes:

• Requires a Maven project to be executed.

• Requires dependency resolution of artifacts in scope: compile+runtime.

• Invokes the execution of the lifecycle phase package.

Optional Parameters

attach (boolean)

Controls whether this mojo attaches the resulting bundle to the Maven project.

Default value is: true

User property is: yamcs.attach

classifier (string)

Classifier to add to the generated bundle.

Default value is: bundle

configurationDirectory (file)

The directory that contains Yamcs configuration files. By convention this contains subfolders named etc and mdb.

Relative paths in yaml configuration files are resolved from this directory.

Default value is: ${basedir}/src/main/yamcs

User property is: yamcs.configurationDirectory

includeDefaultWrappers (boolean)

Whether yamcs and yamcsadmin wrapper scripts should be included in the bundle.

Default value is: true

User property is: yamcs.includeDefaultWrappers

includeConfiguration (boolean)

Whether this module’s configuration directory (default location: src/main/yamcs) should be included in the bundle

Default value is: true

User property is: yamcs.includeConfiguration

useDefaultExcludes (boolean)

New in version 1.2.11.

Set whether the default excludes are being applied.

Default value is: true.

includes (list)

New in version 1.2.11.

Set a string of patterns, which included files should match. Add each argument in an <include> subelement.

excludes (list)

New in version 1.2.11.

Set a string of patterns, which excluded files should match. Add each argument in an <exclude> subelement.

For example:

<excludes>
  <exclude>**/__pycache__/**</exclude>
</excludes>

scope (string)

New in version 1.2.12.

Specifies the Maven scope of bundled dependencies.

• runtime - Bundle runtime and compile dependencies

• compile - Bundle compile, provided and system dependencies

• test - Bundle all dependencies

• provided - Bundle only provided dependencies

• system - Bundle only system dependencies

Default value is: runtime.

formats (list)

Specifies the formats of the bundle. Multiple formats can be supplied. Each format is specified by supplying one of the following values in a <format> subelement:

• zip - Creates a ZIP file format

• tar - Creates a TAR format

• tar.gz or tgz - Creates a gzip’d TAR format

• tar.bz2 or tbz2 - Creates a bzip’d TAR format

• tar.snappy - Creates a snappy’d TAR format

• tar.xz or txz - Creates a xz’d TAR format

• tar.zst or tzst - Creates a zst’d TAR format

If unspecified the behavior is equivalent to:

<formats>
  <format>tar.gz</format>
</formats>

skip (boolean)

Skip execution

Default value is: false

User property is: yamcs.skip