You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by cd...@apache.org on 2016/04/15 12:06:50 UTC
git commit: [flex-falcon] [refs/heads/feature/maven-migration-test] -
- Configured the site-generation - Added support for asciidoctor
documentation content - Fine-tuned the pom: -- Adjusted the git urls -- Added
Jira settings -- Added the dev mailinglis
Repository: flex-falcon
Updated Branches:
refs/heads/feature/maven-migration-test 96ce16348 -> cd7feb859
- Configured the site-generation
- Added support for asciidoctor documentation content
- Fine-tuned the pom:
-- Adjusted the git urls
-- Added Jira settings
-- Added the dev mailinglist
-- Updated the apache partent to version 17
Project: http://git-wip-us.apache.org/repos/asf/flex-falcon/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-falcon/commit/cd7feb85
Tree: http://git-wip-us.apache.org/repos/asf/flex-falcon/tree/cd7feb85
Diff: http://git-wip-us.apache.org/repos/asf/flex-falcon/diff/cd7feb85
Branch: refs/heads/feature/maven-migration-test
Commit: cd7feb859bd443a19096cfcd7b34326ef0288bd2
Parents: 96ce163
Author: Christofer Dutz <ch...@codecentric.de>
Authored: Fri Apr 15 12:06:43 2016 +0200
Committer: Christofer Dutz <ch...@codecentric.de>
Committed: Fri Apr 15 12:06:43 2016 +0200
----------------------------------------------------------------------
compiler-jx/src/site/site.xml | 33 +++++++++
compiler/src/site/site.xml | 33 +++++++++
flex-compiler-oem/src/site/site.xml | 33 +++++++++
pom.xml | 97 ++++++++++++++++++++++++--
src/site/asciidoc/build.adoc | 112 +++++++++++++++++++++++++++++++
src/site/site.xml | 41 +++++++++++
6 files changed, 344 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/cd7feb85/compiler-jx/src/site/site.xml
----------------------------------------------------------------------
diff --git a/compiler-jx/src/site/site.xml b/compiler-jx/src/site/site.xml
new file mode 100644
index 0000000..2cc8e70
--- /dev/null
+++ b/compiler-jx/src/site/site.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Maven">
+
+ <!-- Use the nicer lookinf fluido skin instead of the default -->
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.5</version>
+ </skin>
+
+ <bannerLeft>
+ <name>Apache Flex</name>
+ <src>http://flex.apache.org/images/logo_01_fullcolor-sm.png</src>
+ <href>http://flex.apache.org/</href>
+ </bannerLeft>
+
+ <!--bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight-->
+
+ <body>
+ <links>
+ <item name="Apache Flex Homepage" href="http://flex.apache.org/" />
+ <!--item name="Apache FlexJS Homepage" href="http://flex.apache.org/" /-->
+ <item name="Apache Flex Wiki" href="https://cwiki.apache.org/confluence/display/FLEX/Apache+Flex+Wiki"/>
+ </links>
+
+ <menu ref="reports" />
+ <menu ref="parent" />
+ <menu ref="modules" />
+
+ </body>
+</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/cd7feb85/compiler/src/site/site.xml
----------------------------------------------------------------------
diff --git a/compiler/src/site/site.xml b/compiler/src/site/site.xml
new file mode 100644
index 0000000..2cc8e70
--- /dev/null
+++ b/compiler/src/site/site.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Maven">
+
+ <!-- Use the nicer lookinf fluido skin instead of the default -->
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.5</version>
+ </skin>
+
+ <bannerLeft>
+ <name>Apache Flex</name>
+ <src>http://flex.apache.org/images/logo_01_fullcolor-sm.png</src>
+ <href>http://flex.apache.org/</href>
+ </bannerLeft>
+
+ <!--bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight-->
+
+ <body>
+ <links>
+ <item name="Apache Flex Homepage" href="http://flex.apache.org/" />
+ <!--item name="Apache FlexJS Homepage" href="http://flex.apache.org/" /-->
+ <item name="Apache Flex Wiki" href="https://cwiki.apache.org/confluence/display/FLEX/Apache+Flex+Wiki"/>
+ </links>
+
+ <menu ref="reports" />
+ <menu ref="parent" />
+ <menu ref="modules" />
+
+ </body>
+</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/cd7feb85/flex-compiler-oem/src/site/site.xml
----------------------------------------------------------------------
diff --git a/flex-compiler-oem/src/site/site.xml b/flex-compiler-oem/src/site/site.xml
new file mode 100644
index 0000000..2cc8e70
--- /dev/null
+++ b/flex-compiler-oem/src/site/site.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Maven">
+
+ <!-- Use the nicer lookinf fluido skin instead of the default -->
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.5</version>
+ </skin>
+
+ <bannerLeft>
+ <name>Apache Flex</name>
+ <src>http://flex.apache.org/images/logo_01_fullcolor-sm.png</src>
+ <href>http://flex.apache.org/</href>
+ </bannerLeft>
+
+ <!--bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight-->
+
+ <body>
+ <links>
+ <item name="Apache Flex Homepage" href="http://flex.apache.org/" />
+ <!--item name="Apache FlexJS Homepage" href="http://flex.apache.org/" /-->
+ <item name="Apache Flex Wiki" href="https://cwiki.apache.org/confluence/display/FLEX/Apache+Flex+Wiki"/>
+ </links>
+
+ <menu ref="reports" />
+ <menu ref="parent" />
+ <menu ref="modules" />
+
+ </body>
+</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/cd7feb85/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 8fc21cb..bcf4ee3 100644
--- a/pom.xml
+++ b/pom.xml
@@ -23,7 +23,7 @@
<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
- <version>14</version>
+ <version>17</version>
</parent>
<groupId>org.apache.flex.flexjs</groupId>
@@ -32,7 +32,15 @@
<packaging>pom</packaging>
<name>Apache Flex - FlexJS</name>
- <description>The Apache Flex FlexJS Parent</description>
+ <description>The Apache Flex FlexJS Project</description>
+
+ <!-- Only configure the site distribution as the rest is handled by the apache parent -->
+ <distributionManagement>
+ <site>
+ <id>website</id>
+ <url>scp://www.mycompany.com/www/docs/project/</url>
+ </site>
+ </distributionManagement>
<mailingLists>
<mailingList>
@@ -42,17 +50,30 @@
<post>users@flex.apache.org</post>
<archive>http://mail-archives.apache.org/mod_mbox/flex-users/</archive>
</mailingList>
+ <mailingList>
+ <name>Apache Flex Developer List</name>
+ <subscribe>dev-subscribe@flex.apache.org</subscribe>
+ <unsubscribe>dev-unsubscribe@flex.apache.org</unsubscribe>
+ <post>dev@flex.apache.org</post>
+ <archive>http://mail-archives.apache.org/mod_mbox/flex-dev/</archive>
+ </mailingList>
</mailingLists>
+ <issueManagement>
+ <system>Jira</system>
+ <url>https://issues.apache.org/jira/browse/FLEX</url>
+ </issueManagement>
+
<scm>
- <connection>scm:svn:https://git-wip-us.apache.org/repos/asf/flex-falcon.git</connection>
- <developerConnection>scm:svn:https://git-wip-us.apache.org/repos/asf/flex-falcon.git</developerConnection>
- <url>https://git-wip-us.apache.org/repos/asf/flex-falcon.git</url>
+ <connection>scm:git://git.apache.org/flex-falcon.git</connection>
+ <developerConnection>scm:git://git.apache.org/flex-falcon.git</developerConnection>
+ <url>https://github.com/apache/flex-falcon</url>
</scm>
<properties>
<java.version>1.6</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ <maven.version>3.3.1</maven.version>
<flex.version>4.15.0</flex.version>
<flash.version>20.0</flash.version>
@@ -286,7 +307,73 @@
</descriptors>
</configuration>
</plugin-->
+
+ <!-- Configure the Site generation -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>3.4</version>
+ <configuration>
+ <generateReports>true</generateReports>
+ <generateSitemap>true</generateSitemap>
+ <relativizeDecorationLinks>false</relativizeDecorationLinks>
+ <locales>en</locales>
+ <inputEncoding>UTF-8</inputEncoding>
+ <outputEncoding>UTF-8</outputEncoding>
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ <version>1.5.3</version>
+ </dependency>
+ </dependencies>
+ </plugin>
</plugins>
</build>
+ <reporting>
+ <plugins>
+ <!-- Process the asciidoctor resources in the src/site/asciidoc directory -->
+ <plugin>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ <version>1.5.3</version>
+ <configuration>
+ <attributes>
+ <icons>font</icons>
+ <source-highlighter>coderay</source-highlighter>
+ <coderay-css>style</coderay-css>
+ <toclevels>2</toclevels>
+ </attributes>
+ </configuration>
+ </plugin>
+
+ <!-- Generates a changelog report from GIT commits -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ <version>2.3</version>
+ <configuration>
+ <!-- Automatically link Jire issues -->
+ <issueLinkUrl>https://issues.apache.org/jira/browse/%ISSUE%</issueLinkUrl>
+ </configuration>
+ </plugin>
+
+ <!-- Generated a report with the details of the unit- and integrationtests -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-report-plugin</artifactId>
+ <version>2.19.1</version>
+ </plugin>
+
+ <!-- Generate the JavaDoc API documentation -->
+ <!--plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.10.3</version>
+ </plugin-->
+ </plugins>
+ </reporting>
+
</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/cd7feb85/src/site/asciidoc/build.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/build.adoc b/src/site/asciidoc/build.adoc
new file mode 100644
index 0000000..a79471b
--- /dev/null
+++ b/src/site/asciidoc/build.adoc
@@ -0,0 +1,112 @@
+= Building FlexJS from source
+
+This document will guide you through the process of building FlexJS from source.
+
+== Prerequisites
+
+In order to build FlexJS you require the following software installed on your machine:
+
+- A Java JDK 1.6 or higher (a simple Java runtime is not enough) (http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+- Apache Maven 3.3.1 or higher (http://maven.apache.org)
+- The Flash Player projector content debugger (https://www.adobe.com/support/flashplayer/debug_downloads.html)
+
+Make sure the following environment variable is set to the exact location of the Flash Player projector content debugger:
+
+FLASHPLAYER_DEBUGGER={Absolute path to the executable}
+
+If you are using the commandline you need to make sure the following environment variables is set:
+
+JAVA_HOME={Absolute path to the JDK installation directory}
+
+The following elements have to be added to your systems PATH variable:
+
+{JAVA_HOME}/bin
+{MAVEN_HOME}/bin
+
+The following setup has proven to be usefull:
+
+=== Windows
+
+JAVA_HOME={Absolute path to the JDK installation directory}
+MAVEN_HOME={Absolute path to the Maven installation directory}
+FLASHPLAYER_DEBUGGER={Absolute path to the executable}
+PATH=%PATH%;%JAVA_HOME%\bin;%MAVEN_HOME%\bin
+
+=== Linux / Mac
+
+JAVA_HOME={Absolute path to the JDK installation directory}
+MAVEN_HOME={Absolute path to the Maven installation directory}
+FLASHPLAYER_DEBUGGER={Absolute path to the executable}
+PATH=${PATH}:${JAVA_HOME}/bin;${MAVEN_HOME}/bin
+
+== Building FlexJS
+
+Currently you need to run 3 build in order to build all the parts
+of FlexJS. This is due to the fact that in order to build the
+Compiler and the other parts, we need some tools prior to building
+those parts. After having released these parts for the first time,
+we will no longer require this first build step. The second build
+builds the compiler. The third build is currently needed as we are
+having some classloading issues, that prevent us from using the compiler
+we built as part of the build process, I am expecting this to become
+obsolete soon.
+
+=== Building the Build-Tools
+
+The following command will take care of building the prerequisites:
+
+----
+mvn clean install -P minimal
+----
+
+=== Building the Compiler
+
+The compiler block is the main part of the build. It contains a large
+set of unit- and integrationtests. If you just want to build the
+compiler, the following command will take care of this without running
+the unit- and integrationtests:
+
+----
+mvn clean install -P compiler -DskipTests
+----
+
+If you want to build and run the tests, just omit the `-DskipTests`:
+
+----
+mvn clean install -P compiler
+----
+
+Maven also takes care of building the project website and documentation.
+This is handled as part of the Maven `site` lifecycle. If you want to build
+the documentation for the compiler, the following command will take care of
+this:
+
+----
+mvn site -P compiler
+----
+
+This will create the documentation for each module inside the corresponding
+modules `target/site` directory. However if you open the `index.html` of the
+root project, the links to the sub-modules will not work as the local directory
+structure differs from the strucure the deployed deocumentation would have.
+In order to locally read and test the documentation, the following command will
+wrap all parts into the `target/staging` directory of the project root.
+
+----
+mvn site:stage -P compiler
+----
+
+You can of course wrap all together into one big build:
+
+----
+mvn clean install site site:stage -P compiler
+----
+
+=== Building the externs
+
+Building the externs is quite straight-forward. All you need to do, is run the
+folloging command:
+
+----
+mvn clean install -P externs
+----
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/cd7feb85/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
new file mode 100644
index 0000000..950a88f
--- /dev/null
+++ b/src/site/site.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Maven">
+
+ <!-- Use the nicer lookinf fluido skin instead of the default -->
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.5</version>
+ </skin>
+
+ <bannerLeft>
+ <name>Apache Flex</name>
+ <src>http://flex.apache.org/images/logo_01_fullcolor-sm.png</src>
+ <href>http://flex.apache.org/</href>
+ </bannerLeft>
+
+ <!--bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight-->
+
+ <body>
+ <links>
+ <item name="Apache Flex Homepage" href="http://flex.apache.org/" />
+ <!--item name="Apache FlexJS Homepage" href="http://flex.apache.org/" /-->
+ <item name="Apache Flex Wiki" href="https://cwiki.apache.org/confluence/display/FLEX/Apache+Flex+Wiki"/>
+ </links>
+
+ <menu name="FlexJS">
+ <item name="Introduction" href="index.html"/>
+ <!--item name="Download" href="download.html"/>
+ <item name="Release Notes" href="release-notes.html" />
+ <item name="General Information" href="about.html"/-->
+ <item name="Building from Source" href="build.html"/>
+ </menu>
+
+ <menu ref="reports" />
+ <menu ref="parent" />
+ <menu ref="modules" />
+
+ </body>
+</project>
\ No newline at end of file