This is an automated email from the ASF dual-hosted git repository.
davidb pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-slingfeature-maven-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 0f6b130 Add some documentation for the analyse-features goal
0f6b130 is described below
commit 0f6b130476611d1323431f5be1a27b860db213ea
Author: David Bosschaert <bossc...@adobe.com>
AuthorDate: Fri Nov 9 14:50:35 2018 +0000
Add some documentation for the analyse-features goal
---
README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 42 insertions(+)
diff --git a/README.md b/README.md
index 7235f51..c416c1e 100644
--- a/README.md
+++ b/README.md
@@ -99,6 +99,48 @@ section of the plugin configuration:
</plugin>
```
+### analyse-features
+Run feature model analysers on the feature models in the project. Analysers
are defined in the
+https://github.com/apache/sling-org-apache-sling-feature-analyser project and
are selected by their ID,
+which is obtained from the `getId()` method in
+https://github.com/apache/sling-org-apache-sling-feature-analyser/blob/master/src/main/java/org/apache/sling/feature/analyser/task/AnalyserTask.java
+
+```
+<execution>
+ <id>analyze</id>
+ <phase>validate</phase>
+ <goals>
+ <goal>analyse-features</goal>
+ </goals>
+ <configuration>
+ <scans>
+ <scan>
+ <!-- specify which feature files to include -->
+ <includes>**/*.json</includes>
+
+ <!-- if only a subset of tasks need to be run, specify them here -->
+ <includeTasks>api-regions-dependencies</includeTasks>
+
+ <!-- can also exclude tasks -->
+ <excludeTasks>do-not-run-this-task</excludeTasks>
+
+ <!-- taskConfiguration is a String, Properties map -->
+ <taskConfiguration>
+ <!-- the configuration is specific to the analyser tasks -->
+
+ <!-- each key represents an AnalyserTask ID -->
+ <api-regions-dependencies>
+ <!-- can use keyname-textvalue syntax to specify configuration for
a task -->
+ <exporting-apis>global</exporting-apis>
+ <hiding-apis>internal</hiding-apis>
+ </api-regions-dependencies>
+ </taskConfiguration>
+ </scan>
+ </scans>
+ </configuration>
+</execution>
+```
+
### attach-features
Attach feature files found in the project to the projects produced artifacts.
This includes features
found in `src/main/features` as well as features produce with the
`aggregate-features` goal.
