Fork me on GitHub

slingfeature:info

Full name:

org.apache.sling:slingfeature-maven-plugin:1.9.2:info

Description:

Extract information from a feature This mojo does not require a project, it can be run by just pointing it at a feature file. When run from within a project, the normal feature selection mechanism can be used. This mojo supports

  • Extracting the exported packages per feature and writing them to a file
  • Detecting duplicates across features and writing a report

Attributes:

  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.1.20.

Required Parameters

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

Optional Parameters

Name Type Since Description
<artifactExcludesList> String 1.2.0 A comma separated list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of excludes from the command line.
User Property: excludes
<artifactIncludesList> String 1.2.0 A comma separated list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of includes from the command line.
User Property: includes
<defaultMetadata> Map<...> - This parameter is only declared to make Maven happy, it is evaluated in the Preprossor
<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: 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: true
<featureFile> File -
Deprecated.
No reason given

No description.
User Property: featureFile
<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: **/*.json
<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: **/*.json
<infoFeatureFiles> String - Select the feature files if run in standalone mode; comma separated list of file names.
User Property: infoFeatureFiles
<infoFeatures> FeatureSelectionConfig - Select the features for info generation.
<jarStartOrder> int - The start level for the attached jar/bundle.
<outputDirectory> File - If output format is set to file, this can be used to change the output directory.
User Property: outputDirectory
<outputExportedPackages> String -
Deprecated.
No reason given

No description.
User Property: outputExportedPackages
<outputFormat> String - Output format, either file, singlefile or log.
Default: file
User Property: outputFormat
<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.
<reports> String - Comma separated list of reports.
Default: exported-packages
User Property: reports
<skipAddFeatureDependencies> boolean - If set to true the artifacts from the feature are not added as dependencies with scope=provided to the project.
Default: false
<skipAddJarToFeature> boolean - If set to true the main jar artifact is not added to the feature.
Default: false
<skipAddJarToTestFeature> boolean - If set to true the main jar artifact is not added to the test feature.
Default: false
<skipAddTestFeatureDependencies> boolean - If set to true the artifacts from the test feature are not added as dependencies with scope=test to the project.
Default: true
<testFeaturesExcludes> String - Comma separated list of excludes for the test features.
<testFeaturesIncludes> String - Comma separated list of includes for the test features.
Default: **/*.json
<validateFeatures> boolean - If set to true the features are validated against the JSON schema.
Default: true

Parameter Details

<artifactExcludesList>

A comma separated list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of excludes from the command line.
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: No
  • User Property: excludes

<artifactIncludesList>

A comma separated list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of includes from the command line.
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: No
  • User Property: includes

<defaultMetadata>

This parameter is only declared to make Maven happy, it is evaluated in the Preprossor
  • Type: java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>
  • Required: No

<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

<featureFile>

Deprecated.
No reason given

No description.
  • Type: java.io.File
  • Required: No
  • User Property: featureFile

<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

<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

<infoFeatureFiles>

Select the feature files if run in standalone mode; comma separated list of file names.
  • Type: java.lang.String
  • Required: No
  • User Property: infoFeatureFiles

<infoFeatures>

Select the features for info generation.

<jarStartOrder>

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

<outputDirectory>

If output format is set to file, this can be used to change the output directory.
  • Type: java.io.File
  • Required: No
  • User Property: outputDirectory

<outputExportedPackages>

Deprecated.
No reason given

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: outputExportedPackages

<outputFormat>

Output format, either file, singlefile or log.
  • Type: java.lang.String
  • Required: No
  • User Property: outputFormat
  • Default: file

<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

<reports>

Comma separated list of reports.
  • Type: java.lang.String
  • Required: No
  • User Property: reports
  • Default: exported-packages

<skipAddFeatureDependencies>

If set to true the artifacts from the feature are not added as dependencies with scope=provided 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 added as dependencies with scope=test 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