Apache Sling OSGi Feature Maven Plugin – slingfeature:analyse-features

slingfeature:analyse-features

Full name:

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

Description:

Analyse the feature.

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: test.
The goal is thread-safe and supports parallel builds.
Binds by default to the lifecycle phase: verify.

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
`<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`.
`<failOnAnalyserErrors>`	`boolean`	`-`	(no description) Default value is: `true`. User property is: `failon.analyser.errors`.
`<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`.
`<framework>`	`Dependency`	`-`	The framework to use for analysing the feature models if not contained in an execution-environment extension.
`<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`.
`<jarStartOrder>`	`int`	`-`	The start level for the attached jar/bundle.
`<logWarnings>`	`boolean`	`1.3.8`	By default the warnings from the analysers are logged. Setting this to false disables logging them. Default value is: `true`.
`<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.
`<scans>`	`List`	`-`	The scans for the analyser
`<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`.

Parameter Details

<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

<failOnAnalyserErrors>

(no description)

Type: boolean
Required: No
User Property: failon.analyser.errors
Default: true

<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

<framework>

The framework to use for analysing the feature models if not contained in an execution-environment extension.

Type: org.apache.maven.model.Dependency
Required: No

<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

<jarStartOrder>

The start level for the attached jar/bundle.

Type: int
Required: No

<logWarnings>

By default the warnings from the analysers are logged. Setting this to false disables logging them.

Type: boolean
Since: 1.3.8
Required: No
Default: true

<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