Fork me on GitHub

slingfeature:launch-features

Full name:

org.apache.sling:slingfeature-maven-plugin:1.7.2:launch-features

Description:

Launches the given Feature File

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<features> File - Directory containing feature files
Default value is: src/main/features.
<testFeatures> File - Directory containing test feature files.
Default value is: src/test/features.

Optional Parameters

Name Type Since Description
<artifactClashOverrides> String[] - The Artifact Id Overrides (see Feature Launcher for more info)
User property is: artifactClashOverrides.
<cacheDirectory> File - The path of the folder where the cache is located
User property is: cacheDirectory.
<enableLegacyVariableReplacement> boolean 1.3.6 Enable old variable replacement in feature model based on the full maven project including system variables. If this is enabled, enableProjectVariableReplacement and replacePropertyVariables have no effect.
Default value is: false.
<enableProjectVariableReplacement> boolean 1.3.6 Enable the replacement of variables when reading a feature model. The supported variables are "project.groupId", "project.artifactId", "project.version" and "project.osgiVersion".
Default value is: true.
<extensionConfigurations> String[] - Extension Configurations for the Launcher
User property is: extensionConfigurations.
<featureArchiveClassifiers> Set - Feature Archive Classifiers to be used from this project
User property is: featureArchiveClassifiers.
<featureArchiveFiles> Set - Feature Archive Files
User property is: featureArchiveFiles.
<featureArchiveIds> Set - Ids of Feature Archives to be obtained from local Maven repository
User property is: featureArchiveIds.
<featuresExcludes> String - Comma separated list of excludes for the feature files. Feature files excluded by this configuration are not processed at all.
<featuresIncludes> String - Comma separated list of includes for the feature files in the configured directory. Only feature files specified by this include are processed.
Default value is: **/*.json.
<frameworkArtifacts> String[] - Framework Artifacts for the Launcher
User property is: frameworkArtifacts.
<frameworkProperties> String[] - Framework Properties for the Launcher
User property is: frameworkProperties.
<frameworkVersion> String - The Framework Version (see Feature Launcher for more info)
User property is: frameworkVersion.
<generatedFeatures> File - Directory containing generated feature files
<generatedFeaturesExcludes> String - Comma separated list of excludes for the generated feature files. Feature files excluded by this configuration are not processed at all.
<generatedFeaturesIncludes> String - Comma separated list of includes for the generated feature files in the configured directory. Only feature files specified by this include are processed.
Default value is: **/*.json.
<homeDirectory> File - The path of the folder where the launcher home is located
User property is: homeDirectory.
<jarStartOrder> int - The start level for the attached jar/bundle.
<replacePropertyVariables> String 1.3.6 A comma separated list of variables which are replaced when a feature model is read. The value of these variables is fetched from the project properties.
<repositoryUrl> String - The Url for the Repository (see Feature Launcher for more info)
User property is: frameworkRepositoryUrl.
<selection> FeatureSelectionConfig - (no description)
<skipAddFeatureDependencies> boolean - If set to true the artifacts from the feature are not as dependencies to the project.
Default value is: false.
<skipAddJarToFeature> boolean - If set to true the main jar artifact is not added to the feature.
Default value is: false.
<skipAddJarToTestFeature> boolean - If set to true the main jar artifact is not added to the test feature.
Default value is: false.
<skipAddTestFeatureDependencies> boolean - If set to true the artifacts from the test feature are not as dependencies to the project.
Default value is: true.
<testFeaturesExcludes> String - Comma separated list of excludes for the test features.
<testFeaturesIncludes> String - Comma separated list of includes for the test features.
Default value is: **/*.json.
<validateFeatures> boolean - If set to true the features are validated against the JSON schema.
Default value is: true.
<variableValues> String[] - Variable Values for the Launcher
User property is: variableValues.
<verbose> boolean - Framework Properties for the Launcher
Default value is: false.
User property is: verbose.

Parameter Details

<artifactClashOverrides>

The Artifact Id Overrides (see Feature Launcher for more info)
  • Type: java.lang.String[]
  • Required: No
  • User Property: artifactClashOverrides

<cacheDirectory>

The path of the folder where the cache is located
  • Type: java.io.File
  • Required: No
  • User Property: cacheDirectory

<enableLegacyVariableReplacement>

Enable old variable replacement in feature model based on the full maven project including system variables. If this is enabled, enableProjectVariableReplacement and replacePropertyVariables have no effect.
  • Type: boolean
  • Since: 1.3.6
  • Required: No
  • Default: false

<enableProjectVariableReplacement>

Enable the replacement of variables when reading a feature model. The supported variables are "project.groupId", "project.artifactId", "project.version" and "project.osgiVersion".
  • Type: boolean
  • Since: 1.3.6
  • Required: No
  • Default: true

<extensionConfigurations>

Extension Configurations for the Launcher
  • Type: java.lang.String[]
  • Required: No
  • User Property: extensionConfigurations

<featureArchiveClassifiers>

Feature Archive Classifiers to be used from this project
  • Type: java.util.Set
  • Required: No
  • User Property: featureArchiveClassifiers

<featureArchiveFiles>

Feature Archive Files
  • Type: java.util.Set
  • Required: No
  • User Property: featureArchiveFiles

<featureArchiveIds>

Ids of Feature Archives to be obtained from local Maven repository
  • Type: java.util.Set
  • Required: No
  • User Property: featureArchiveIds

<features>

Directory containing feature files
  • Type: java.io.File
  • Required: Yes
  • Default: src/main/features

<featuresExcludes>

Comma separated list of excludes for the feature files. Feature files excluded by this configuration are not processed at all.
  • Type: java.lang.String
  • Required: No

<featuresIncludes>

Comma separated list of includes for the feature files in the configured directory. Only feature files specified by this include are processed.
  • Type: java.lang.String
  • Required: No
  • Default: **/*.json

<frameworkArtifacts>

Framework Artifacts for the Launcher
  • Type: java.lang.String[]
  • Required: No
  • User Property: frameworkArtifacts

<frameworkProperties>

Framework Properties for the Launcher
  • Type: java.lang.String[]
  • Required: No
  • User Property: frameworkProperties

<frameworkVersion>

The Framework Version (see Feature Launcher for more info)
  • Type: java.lang.String
  • Required: No
  • User Property: frameworkVersion

<generatedFeatures>

Directory containing generated feature files
  • Type: java.io.File
  • Required: No

<generatedFeaturesExcludes>

Comma separated list of excludes for the generated feature files. Feature files excluded by this configuration are not processed at all.
  • Type: java.lang.String
  • Required: No

<generatedFeaturesIncludes>

Comma separated list of includes for the generated feature files in the configured directory. Only feature files specified by this include are processed.
  • Type: java.lang.String
  • Required: No
  • Default: **/*.json

<homeDirectory>

The path of the folder where the launcher home is located
  • Type: java.io.File
  • Required: No
  • User Property: homeDirectory

<jarStartOrder>

The start level for the attached jar/bundle.
  • Type: int
  • Required: No

<replacePropertyVariables>

A comma separated list of variables which are replaced when a feature model is read. The value of these variables is fetched from the project properties.
  • Type: java.lang.String
  • Since: 1.3.6
  • Required: No

<repositoryUrl>

The Url for the Repository (see Feature Launcher for more info)
  • Type: java.lang.String
  • Required: No
  • User Property: frameworkRepositoryUrl

<selection>

(no description)
  • Type: org.apache.sling.feature.maven.mojos.FeatureSelectionConfig
  • Required: No

<skipAddFeatureDependencies>

If set to true the artifacts from the feature are not as dependencies to the project.
  • Type: boolean
  • Required: No
  • Default: false

<skipAddJarToFeature>

If set to true the main jar artifact is not added to the feature.
  • Type: boolean
  • Required: No
  • Default: false

<skipAddJarToTestFeature>

If set to true the main jar artifact is not added to the test feature.
  • Type: boolean
  • Required: No
  • Default: false

<skipAddTestFeatureDependencies>

If set to true the artifacts from the test feature are not as dependencies to the project.
  • Type: boolean
  • Required: No
  • Default: true

<testFeatures>

Directory containing test feature files.
  • Type: java.io.File
  • Required: Yes
  • Default: src/test/features

<testFeaturesExcludes>

Comma separated list of excludes for the test features.
  • Type: java.lang.String
  • Required: No

<testFeaturesIncludes>

Comma separated list of includes for the test features.
  • Type: java.lang.String
  • Required: No
  • Default: **/*.json

<validateFeatures>

If set to true the features are validated against the JSON schema.
  • Type: boolean
  • Required: No
  • Default: true

<variableValues>

Variable Values for the Launcher
  • Type: java.lang.String[]
  • Required: No
  • User Property: variableValues

<verbose>

Framework Properties for the Launcher
  • Type: boolean
  • Required: No
  • User Property: verbose
  • Default: false