- Added default, minimal and release profiles.
- Added configuration for site generation.
diff --git a/flex-maven-plugin/pom.xml b/flex-maven-plugin/pom.xml
index 87d2264..2fb1373 100644
--- a/flex-maven-plugin/pom.xml
+++ b/flex-maven-plugin/pom.xml
@@ -58,11 +58,44 @@
</developers>
<scm>
- <developerConnection>
- scm:git:https://git-wip-us.apache.org/repos/asf/flex-utilities.git
- </developerConnection>
+ <connection>scm:git:https://git-wip-us.apache.org/repos/asf/flex-utilities.git</connection>
+ <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/flex-utilities.git</developerConnection>
+ <url>https://git-wip-us.apache.org/repos/asf/flex-sdk/repo?p=flex-utilities.git;a=tree</url>
</scm>
+ <distributionManagement>
+ <repository>
+ <id>apache.releases.https</id>
+ <url>https://repository.apache.org/service/local/staging/deploy/maven2</url>
+ </repository>
+ <snapshotRepository>
+ <id>apache.snapshots.https</id>
+ <url>https://repository.apache.org/content/repositories/snapshots</url>
+ </snapshotRepository>
+ </distributionManagement>
+
+ <mailingLists>
+ <mailingList>
+ <name>Users Mailing List</name>
+ <subscribe>users-subscribe@flex.apache.org</subscribe>
+ <unsubscribe>users-unsubscribe@flex.apache.org</unsubscribe>
+ <post>users@flex.apache.org</post>
+ <archive>http://markmail.org/search/+list:org.apache.incubator.flex-users</archive>
+ </mailingList>
+ <mailingList>
+ <name>Development Mailing List</name>
+ <subscribe>dev-subscribe@flex.apache.org</subscribe>
+ <unsubscribe>dev-unsubscribe@flex.apache.org</unsubscribe>
+ <post>dev@flex.apache.org</post>
+ <archive>http://markmail.org/search/+list:org.apache.incubator.flex-dev</archive>
+ </mailingList>
+ </mailingLists>
+
+ <issueManagement>
+ <system>Apache Flex Jira</system>
+ <url>https://issues.apache.org/jira/browse/FLEX</url>
+ </issueManagement>
+
<properties>
<project.encoding>UTF-8</project.encoding>
<project.build.sourceEncoding>${project.encoding}</project.build.sourceEncoding>
@@ -70,12 +103,6 @@
<maven.version>3.1.1</maven.version>
</properties>
- <modules>
- <module>plugins</module>
- <module>components</module>
- <module>testsuite</module>
- </modules>
-
<build>
<plugins>
<plugin>
@@ -119,4 +146,75 @@
</dependencies>
</dependencyManagement>
+ <profiles>
+ <!--
+ Default profile building the entire plugin as well as executing any tests.
+ -->
+ <profile>
+ <id>default</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+
+ <modules>
+ <module>plugins</module>
+ <module>components</module>
+ <module>testsuite</module>
+ </modules>
+ </profile>
+
+ <!--
+ Minimal profile building only the plugin as well as the plugins direct dependencies.
+ When updating the version of this plugin the maven build will fail for all modules
+ depending on the plugin itself. Using the minimal profile for the first build will make
+ sure the plugin is available in the local maven repository.
+ -->
+ <profile>
+ <id>minimal</id>
+
+ <modules>
+ <module>plugins</module>
+ </modules>
+ </profile>
+
+ <!--
+ Additionally to building everything and running all tests, this profile will also
+ generate the plugin documentation and reports. This is usually a time-consuming
+ task, that should not be run every time a build is performed.
+ -->
+ <profile>
+ <id>release</id>
+
+ <modules>
+ <module>plugins</module>
+ <module>components</module>
+ <module>testsuite</module>
+ </modules>
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-plugin-plugin</artifactId>
+ <version>3.2</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.9.1</version>
+ <configuration>
+ <minmemory>128m</minmemory>
+ <maxmemory>512m</maxmemory>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ <version>2.4</version>
+ </plugin>
+ </plugins>
+ </reporting>
+ </profile>
+ </profiles>
+
</project>
\ No newline at end of file
diff --git a/flex-maven-plugin/src/site/apt/index.apt b/flex-maven-plugin/src/site/apt/index.apt
new file mode 100644
index 0000000..1376a2b
--- /dev/null
+++ b/flex-maven-plugin/src/site/apt/index.apt
@@ -0,0 +1,53 @@
+ ------
+ Introduction
+ ------
+ Author
+ ------
+ YYYY-MM-DD
+ ------
+
+
+Plugin Name
+
+ Plugin introduction, description, and other relevant information.
+
+* Goals Overview
+
+ General information about the goals.
+
+ * {{{<goal>.html}flex:generate}} short description for this plugin goal.
+ * {{{<goal>.html}flex:compile}} short description for this plugin goal.
+ * {{{<goal>.html}flex:test-generate}} short description for this plugin goal.
+ * {{{<goal>.html}flex:test-compile}} short description for this plugin goal.
+ * {{{<goal>.html}flex:test}} short description for this plugin goal.
+ * {{{<goal>.html}flex:optimize}} short description for this plugin goal.
+ * {{{<goal>.html}flex:package}} short description for this plugin goal.
+
+* Usage
+
+ General instructions on how to use the Plugin Name can be found on the {{{usage.html}usage page}}. Some more
+ specific use cases are described in the examples given below. Last but not least, users occasionally contribute
+ additional examples, tips or errata to the
+ {{{http://docs.codehaus.org/display/MAVENUSER/Plugin+Name}plugin's wiki page}}.
+
+ In case you still have questions regarding the plugin's usage, please have a look at the {{{faq.html}FAQ}} and feel
+ free to contact the {{{mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
+ already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
+ the {{{mail-lists.html}mail archive}}.
+
+ If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
+ {{{issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
+ concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
+ entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
+ Of course, patches are welcome, too. Contributors can check out the project from our
+ {{{source-repository.html}source repository}} and will find supplementary information in the
+ {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
+
+* Examples
+
+ To provide you with better understanding of some usages of the Plugin Name,
+ you can take a look into the following examples:
+
+ * {{{examples/example-one.html}Example Description One}}
+
+ * {{{examples/example-two.html}Example Description Two}}
\ No newline at end of file
diff --git a/flex-maven-plugin/src/site/fml/faq.fml b/flex-maven-plugin/src/site/fml/faq.fml
new file mode 100644
index 0000000..446b154
--- /dev/null
+++ b/flex-maven-plugin/src/site/fml/faq.fml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="question">
+ <question>What is the difference between the flex-maven-plugin and flexmojos-maven-plugin?</question>
+ <answer>
+ <p>
+ Flexmojos was developed for Adobe Flex and supports versions down to 1.x. This added a lot of compatability problems that made maintaining the plugin very hard. But the even more important part was due to it's licensing it was almost impossible to donate Flexmojos to Apache Flex. Creating a new plugin that is developed directly for Apache Flex and the new Falcon compiler resolves those licensing issues, gets rid of compatibility code and allows us to release the plugin together with the rest of the Flex framework.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
diff --git a/flex-maven-plugin/src/site/site.xml b/flex-maven-plugin/src/site/site.xml
new file mode 100644
index 0000000..7e9c6e4
--- /dev/null
+++ b/flex-maven-plugin/src/site/site.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project>
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
+ <item name="FAQ" href="faq.html"/>
+ </menu>
+
+ <!--menu name="Examples">
+ <item name="description1" href="examples/example-one.html"/>
+ <item name="description2" href="examples/example-two.html"/>
+ </menu-->
+
+ ${reports}
+
+ </body>
+</project>
\ No newline at end of file
