alleon-plugins.wildfly-galleon-maven-plugin.7.1.0.Final.source-code.build-user-feature-pack-mojo.adoc Maven / Gradle / Ivy
### build-user-feature-pack
#### wildfly-galleon:build-user-feature-pack
*Full name:*
org.wildfly.galleon-plugins:wildfly-galleon-maven-plugin:7.1.0.Final:build-user-feature-pack
#### Description
This Maven Mojo is intended to be used to build feature-packs that
depend on one of the WildFly feature-packs. This Maven mojo creates
a WildFly style feature-pack archive from the provided resources
according to the feature-pack build configuration file and attaches
it to the current Maven project as an artifact. If no feature-pack
build configuration is provided, some defaults are applied. The
content of the future feature-pack archive is first created in the
directory called `feature-pack-layout` under the module's build
directory which is then ZIPped to create the feature-pack artifact.
#### Attributes
* Requires a Maven project to be executed.
* Requires dependency resolution of artifacts in scope: `runtime`.
* Binds by default to the http://maven.apache.org/ref/current/maven-core/lifecycles.html[lifecycle phase]: `compile`.
.Required Parameters
[%autowidth.stretch]
|====
|Name|Type|Since|Description
|`<>`|`String`|`-`|Represents the directory containing child directories
`packages`, `feature_groups`,
`modules` etc. Either an absolute path or a path
relative to `configDir`. +
*Default value is*: `src/main/resources`. +
*User property is*: `wildfly.user.feature.pack.resourcesDir`. +
*Alias is*: `resources-dir`.
|====
.Optional Parameters
[%autowidth.stretch]
|====
|Name|Type|Since|Description
|`<>`|`boolean`|`-`|Add any feature-pack dependency as a required manifest in the
manifest YAML definition. This parameter has no effect if
"generate-channel-manifest" is false. +
*Default value is*: `true`. +
*Alias is*: `add-feature-packs-as-required-manifests`.
|`<>`|`String`|`-`|The directory for the built artifact. +
*Default value is*: `${project.build.directory}`. +
*User property is*: `wildfly.user.feature.pack.buildName`. +
|`<>`|`File`|`-`|The feature-pack build configuration file directory +
*Default value is*: `${basedir}`. +
*User property is*: `wildfly.user.feature.pack.configDir`. +
*Alias is*: `config-dir`.
|`<>`|`String`|`-`|The feature-pack build configuration file. +
*Default value is*: `wildfly-user-feature-pack-build.xml`. +
*User property is*: `wildfly.user.feature.pack.configFile`. +
*Alias is*: `config-file`.
|`<>`|`String`|`-`|The default stability level used at provisioning time to generate
configuration. Can't be used when `stability-level` is
set. It overrides the value set in the
wildfly-feature-pack-build.xml file. +
*Alias is*: `config-stability-level`.
|`<>`|`boolean`|`-`|(no description) +
*Default value is*: `true`. +
*User property is*: `wildfly.feature.pack.deploy-channel-manifest`. +
*Alias is*: `deploy-channel-manifest`.
|`<>`|`boolean`|`-`|Enforce that no package at a lower stability level than the
minimum-stability-level is referenced from Galleon constructs. +
*Default value is*: `false`. +
*Alias is*: `forbid-lower-stability-level-package-reference`.
|`<>`|`String`|`-`|The FPL for the generated feature-pack. +
*Default value is*: `${project.groupId}:${project.artifactId}:${project.version}`. +
*Alias is*: `feature-pack-location`.
|`<>`|`boolean`|`-`|Generates a channel manifest YAML definition when the feature-pack
is produced. Any dependency from the feature pack is declared as a
stream in the channel manifest. +
*Default value is*: `false`. +
*User property is*: `wildfly.feature.pack.generate-channel-manifest`. +
*Alias is*: `generate-channel-manifest`.
|`<>`|`String`|`-`|The minimum stability level of the WildFly processes used to
generate feature specs and include packages. Set this if you need
to generate feature specs for features with a lower stability level
than the default level of the WildFly process being used for
feature-spec generation. It overrides the value set in the
wildfly-feature-pack-build.xml file. +
*Alias is*: `minimum-stability-level`.
|`<>`|`String`|`-`|The default stability level used at provisioning time when
installing packages/JBoss Modules modules. Can't be used when
`stability-level` is set. If both the
`config-stability-level` and the
`package-stability-level` options are set, the level of
the `package-stability-level` option must imply the
level of the `config-stability-level` option. It
overrides the value set in the wildfly-feature-pack-build.xml file. +
*Alias is*: `package-stability-level`.
|`<>`|`String`|`-`|The name of the release the feature-pack represents which will be
stored in the feature-pack's
`resources/wildfly/wildfly-tasks.properties` as
`product.release.name` property. +
*Default value is*: `${product.release.name}`. +
*Alias is*: `release-name`.
|`<>`|`String`|`-`|The default stability level used at provisioning time to generate
configuration and provision packages. Can't be used when
`config-stability-level` or
`package-stability-level` is set. It overrides the value
set in the wildfly-feature-pack-build.xml file. +
*Alias is*: `stability-level`.
|`<>`|`Map`|`-`|Various properties that will be added to feature-pack's
`resources/wildfly/wildfly-tasks.properties`. +
NOTE: values of this parameter will overwrite the corresponding
values from task-properties-file parameter, in case it's also
set. + +
*Alias is*: `task-properties`.
|`<>`|`File`|`-`|Path to a properties file content of which will be added to
feature-pack's `resources/wildfly/wildfly-tasks.properties` file
that is used as the source of properties during file copying tasks
with property replacement. +
*Alias is*: `task-properties-file`.
|`<>`|`Boolean`|`-`|By default generated build config dependencies are expressed using
GAV, set this parameter to true to generate FPL. +
*Default value is*: `false`. +
*Alias is*: `translate-to-fpl`.
|`<>`|`WildFlyChannelResolutionMode`|`-`|Feature-pack WildFly channel resolution mode when WildFly channels
are configured in the provisioning tooling used to provision this
feature-pack. "NOT_REQUIRED" means that the feature-pack and
artifacts can be resolved without WildFly channels. "REQUIRED"
means that the feature-pack and all its artifacts must be only
resolved from WildFly channels. "REQUIRED_FP_ONLY" means that only
the feature-pack must be only resolved from WildFly channels.
Referenced artifacts can be resolved outside of configured WildFly
channels. +
*Default value is*: `NOT_REQUIRED`. +
*User property is*: `wildfly.feature.pack.require.channel.resolution`. +
*Alias is*: `wildfly-channel-resolution-mode`.
|====
#### Parameter Details
[[addFeaturePacksAsRequiredManifests]] *addFeaturePacksAsRequiredManifests* +
Add any feature-pack dependency as a required manifest in the
manifest YAML definition. This parameter has no effect if
"generate-channel-manifest" is false.
* *Type*: `boolean`
* *Required*: `No`
* *Default*: `true`
* *Alias*: `add-feature-packs-as-required-manifests`
[[buildName]] *buildName* +
The directory for the built artifact.
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.user.feature.pack.buildName`
* *Default*: `${project.build.directory}`
[[configDir]] *configDir* +
The feature-pack build configuration file directory
* *Type*: `java.io.File`
* *Required*: `No`
* *User Property*: `wildfly.user.feature.pack.configDir`
* *Default*: `${basedir}`
* *Alias*: `config-dir`
[[configFile]] *configFile* +
The feature-pack build configuration file.
* *Type*: `java.lang.String`
* *Required*: `No`
* *User Property*: `wildfly.user.feature.pack.configFile`
* *Default*: `wildfly-user-feature-pack-build.xml`
* *Alias*: `config-file`
[[configStabilityLevel]] *configStabilityLevel* +
The default stability level used at provisioning time to generate
configuration. Can't be used when `stability-level` is
set. It overrides the value set in the
wildfly-feature-pack-build.xml file.
* *Type*: `java.lang.String`
* *Required*: `No`
* *Alias*: `config-stability-level`
[[deployChannelManifest]] *deployChannelManifest* +
(no description)
* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.feature.pack.deploy-channel-manifest`
* *Default*: `true`
* *Alias*: `deploy-channel-manifest`
[[forbidLowerStatibilityLevelPackageReference]] *forbidLowerStatibilityLevelPackageReference* +
Enforce that no package at a lower stability level than the
minimum-stability-level is referenced from Galleon constructs.
* *Type*: `boolean`
* *Required*: `No`
* *Default*: `false`
* *Alias*: `forbid-lower-stability-level-package-reference`
[[fpLocation]] *fpLocation* +
The FPL for the generated feature-pack.
* *Type*: `java.lang.String`
* *Required*: `No`
* *Default*: `${project.groupId}:${project.artifactId}:${project.version}`
* *Alias*: `feature-pack-location`
[[generateChannelManifest]] *generateChannelManifest* +
Generates a channel manifest YAML definition when the feature-pack
is produced. Any dependency from the feature pack is declared as a
stream in the channel manifest.
* *Type*: `boolean`
* *Required*: `No`
* *User Property*: `wildfly.feature.pack.generate-channel-manifest`
* *Default*: `false`
* *Alias*: `generate-channel-manifest`
[[minimumStabilityLevel]] *minimumStabilityLevel* +
The minimum stability level of the WildFly processes used to
generate feature specs and include packages. Set this if you need
to generate feature specs for features with a lower stability level
than the default level of the WildFly process being used for
feature-spec generation. It overrides the value set in the
wildfly-feature-pack-build.xml file.
* *Type*: `java.lang.String`
* *Required*: `No`
* *Alias*: `minimum-stability-level`
[[packageStabilityLevel]] *packageStabilityLevel* +
The default stability level used at provisioning time when
installing packages/JBoss Modules modules. Can't be used when
`stability-level` is set. If both the
`config-stability-level` and the
`package-stability-level` options are set, the level of
the `package-stability-level` option must imply the
level of the `config-stability-level` option. It
overrides the value set in the wildfly-feature-pack-build.xml file.
* *Type*: `java.lang.String`
* *Required*: `No`
* *Alias*: `package-stability-level`
[[releaseName]] *releaseName* +
The name of the release the feature-pack represents which will be
stored in the feature-pack's
`resources/wildfly/wildfly-tasks.properties` as
`product.release.name` property.
* *Type*: `java.lang.String`
* *Required*: `No`
* *Default*: `${product.release.name}`
* *Alias*: `release-name`
[[resourcesDir]] *resourcesDir* +
Represents the directory containing child directories
`packages`, `feature_groups`,
`modules` etc. Either an absolute path or a path
relative to `configDir`.
* *Type*: `java.lang.String`
* *Required*: `Yes`
* *User Property*: `wildfly.user.feature.pack.resourcesDir`
* *Default*: `src/main/resources`
* *Alias*: `resources-dir`
[[stabilityLevel]] *stabilityLevel* +
The default stability level used at provisioning time to generate
configuration and provision packages. Can't be used when
`config-stability-level` or
`package-stability-level` is set. It overrides the value
set in the wildfly-feature-pack-build.xml file.
* *Type*: `java.lang.String`
* *Required*: `No`
* *Alias*: `stability-level`
[[taskProps]] *taskProps* +
Various properties that will be added to feature-pack's
`resources/wildfly/wildfly-tasks.properties`. +
NOTE: values of this parameter will overwrite the corresponding
values from task-properties-file parameter, in case it's also
set. +
* *Type*: `java.util.Map`
* *Required*: `No`
* *Alias*: `task-properties`
[[taskPropsFile]] *taskPropsFile* +
Path to a properties file content of which will be added to
feature-pack's `resources/wildfly/wildfly-tasks.properties` file
that is used as the source of properties during file copying tasks
with property replacement.
* *Type*: `java.io.File`
* *Required*: `No`
* *Alias*: `task-properties-file`
[[translateToFpl]] *translateToFpl* +
By default generated build config dependencies are expressed using
GAV, set this parameter to true to generate FPL.
* *Type*: `java.lang.Boolean`
* *Required*: `No`
* *Default*: `false`
* *Alias*: `translate-to-fpl`
[[wildflyChannelResolutionMode]] *wildflyChannelResolutionMode* +
Feature-pack WildFly channel resolution mode when WildFly channels
are configured in the provisioning tooling used to provision this
feature-pack. "NOT_REQUIRED" means that the feature-pack and
artifacts can be resolved without WildFly channels. "REQUIRED"
means that the feature-pack and all its artifacts must be only
resolved from WildFly channels. "REQUIRED_FP_ONLY" means that only
the feature-pack must be only resolved from WildFly channels.
Referenced artifacts can be resolved outside of configured WildFly
channels.
* *Type*: `org.wildfly.galleon.plugin.WildFlyChannelResolutionMode`
* *Required*: `No`
* *User Property*: `wildfly.feature.pack.require.channel.resolution`
* *Default*: `NOT_REQUIRED`
* *Alias*: `wildfly-channel-resolution-mode`