You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2020/03/20 06:29:17 UTC
[sling-slingfeature-maven-plugin] branch master updated: Update
documentation to mention support for generated features,
remove duplicate documentation
This is an automated email from the ASF dual-hosted git repository.
cziegeler 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 5d11439 Update documentation to mention support for generated features, remove duplicate documentation
5d11439 is described below
commit 5d1143901a149c5010fd1602388a439b87dc1384
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Fri Mar 20 07:28:51 2020 +0100
Update documentation to mention support for generated features, remove duplicate documentation
---
README.md | 8 ++++++-
src/site/markdown/index.md | 8 +++----
src/site/markdown/usage.md.vm | 56 +------------------------------------------
3 files changed, 12 insertions(+), 60 deletions(-)
diff --git a/README.md b/README.md
index 8796b1b..67a08e3 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
This module is part of the [Apache Sling](https://sling.apache.org) project.
-Maven Plugin for OSGi Applications
+Maven Plugin for building OSGi features and applications.
# Authoring Feature Files
@@ -47,6 +47,12 @@ If your feature is named `feature.json` then this becomes the main artifact of t
This global configuration specifies the initial set of feature files used for the current project, the other goals can then refine this subset.
+There might be other plugins involved which generate feature files are part of the build. This plugin by default looks into a directory named *generated-features* inside the build directory for such files. Including of generated files can be controlled with the following configurations:
+
+* generatedFeatures : Directory with the generated features. By default *generated-features* inside the build directory is used.
+* generatedFeaturesIncludes : The include pattern for feature files from the above directory. Default is `**/*.json`, therefore all files with the extension `.json` are read including sub directories.
+* generatedFeaturesExcludes : The exclude pattern for feature files from the above directory. Empty by default.
+
# Supported goals
Most of the plugin goals take a selection of features as input, for example to aggregate a set of features to a new feature or to analyse a specific set of features according to some rules.
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 47d0d0b..afe6a1c 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,9 +1,9 @@
-OSGiMaven Plugin
-================
+Apache Sling OSGi Feature Maven Plugin
+======================================
-Maven Plugin for OSGi Applications
+Maven Plugin for building OSGi features and applications.
See [Goals](plugin-info.html) for a list of supported goals.
### Usage
-Additional Documentation can be found on the [usage](usage.html) page.
+Additional Documentation can be found in the [README](https://github.com/apache/sling-slingfeature-maven-plugin/blob/master/README.md) page.
diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm
index 1844092..bc829e1 100644
--- a/src/site/markdown/usage.md.vm
+++ b/src/site/markdown/usage.md.vm
@@ -9,58 +9,4 @@
$h2 Usage
-$h3 Single Feature Model Project
-
-A single Feature Model project cannot have a **classiier** otherwise it will fail to create the **slingosgifeature**
-file.
-
-This is an example Plugin configuration:
-```
-<plugin>
- <groupId>org.apache.sling</groupId>
- <artifactId>slingfeature-maven-plugin</artifactId>
- <version>${sp}slingfeature-maven-plugin.version${ep}</version>
- <extensions>true</extensions>
- <configuration>
- <features>target/fm</features>
- <!--
- This project's FM is generated by the Content Package Converter and so the next line is here to inform
- the plugin that the FM might not be there at the start of the build
- -->
- <generatedFeatures>${sp}basedir${ep}/target/fm</generatedFeatures>
- </configuration>
- <executions>
- <execution>
- <id>aggregate-aem-features</id>
- <phase>generate-test-sources</phase>
- <goals>
- <goal>aggregate-features</goal>
- </goals>
- <configuration>
- <aggregates>
- <aggregate>
- <!--
- A classifier must not be provided in a single FM project build as the installation will fail,
- so next line must be deleted
- -->
- <classifier>test</classifier>
- <description>Single Feature Project</description>
- <filesInclude>**/*.json</filesInclude>
- </aggregate>
- </aggregates>
- </configuration>
- </execution>
- <execution>
- <id>attach-base-feature</id>
- <phase>process-test-sources</phase>
- <goals>
- <goal>attach-features</goal>
- </goals>
- </execution>
- </executions>
-</plugin>
-```
-The FM aggregation is done and the appropriate project FM is created but that FM is not installed due to the classifier
-and so the build fails during the installation phase.
-
-Remove the **<classifier/>** node and the build will run through smoothly.
+Additional Documentation can be found in the [README](https://github.com/apache/sling-slingfeature-maven-plugin/blob/master/README.md) page.