Add generate-readme target
git-svn-id: https://svn.apache.org/repos/asf/ant/easyant/plugins/trunk@1502970 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/easyant-plugin-documentation/module.ivy b/easyant-plugin-documentation/module.ivy
index ed0af0b..a7a78d9 100644
--- a/easyant-plugin-documentation/module.ivy
+++ b/easyant-plugin-documentation/module.ivy
@@ -29,5 +29,6 @@
</configurations>
<publications>
<artifact type="ant" />
+ <artifact type="xsl" ext="xsl" name="easyant-report-markdown"/>
</publications>
</ivy-module>
diff --git a/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant b/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant
index 01e4216..7f55b3e 100644
--- a/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant
+++ b/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant
@@ -16,22 +16,24 @@
-->
<project name="org.apache.easyant.plugins;easyant-plugin-documentation" xmlns:ivy="antlib:org.apache.ivy.ant"
xmlns:ea="antlib:org.apache.easyant">
- <ea:core-version requiredrevision="[0.9,+]" />
+ <ea:core-version requiredrevision="[0.10,+]" />
<ea:parameter property="target.documentation.dir" default="${target}/documentation"
description="directory where the documentation will be generated to" />
-
- <target name="easyant-plugin-documentation:report">
+ <target name="easyant-plugin-documentation:init">
<ea:parameter property="plugindoc.module.ivy" description="plugin's module ivy used to know dependencies"
default="${basedir}/module.ivy" />
<ea:parameter property="plugindoc.source.dir" description="plugin's source dirrectory used to know targets/extensionPoints etc..."
required="true" />
<ea:parameter property="plugindoc.main.confs" description="plugin's main conf" default="default" />
+ </target>
+
+ <target name="easyant-plugin-documentation:report" depends="easyant-plugin-documentation:init">
<ea:plugin-report moduleIvy="${plugindoc.module.ivy}" sourceDirectory="${plugindoc.source.dir}"
conf="${plugindoc.main.confs}" todir="${target.documentation.dir}" />
</target>
-
+
<target name="easyant-plugin-documentation:package" depends="easyant-plugin-documentation:report"
description="generate a package containing plugin documentation">
<ea:parameter property="target.artifacts" default="${target}/artifacts" description="destination directory for target artifacts" />
@@ -40,6 +42,12 @@
<fileset dir="${target.documentation.dir}" erroronmissingdir="false" />
</zip>
</target>
+
+ <target name="easyant-plugin-documentation:generate-readme" depends="easyant-plugin-documentation:init">
+ <ea:plugin-report moduleIvy="${plugindoc.module.ivy}" sourceDirectory="${plugindoc.source.dir}" xslext="markdown"
+ xslFile="${org.apache.easyant.plugins#easyant-plugin-documentation.easyant-report-markdown.xsl.file}"
+ conf="${plugindoc.main.confs}" todir="${target.documentation.dir}" tofile="README.md" />
+ </target>
<target name="easyant-plugin-documentation:register-artifact" depends="easyant-plugin-documentation:package">
<ea:parameter property="plugindoc.publish.type" default="zip"
diff --git a/easyant-plugin-documentation/src/main/resources/easyant-report-mardown.xsl b/easyant-plugin-documentation/src/main/resources/easyant-report-markdown.xsl
similarity index 100%
rename from easyant-plugin-documentation/src/main/resources/easyant-report-mardown.xsl
rename to easyant-plugin-documentation/src/main/resources/easyant-report-markdown.xsl
diff --git a/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml b/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml
index 41a76f8..996b72f 100644
--- a/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml
+++ b/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml
@@ -29,6 +29,7 @@
<delete dir="${basedir}" includeemptydirs="true">
<include name="**/target/**" />
<include name="**/lib/**" />
+ <include name="README.md"/>
</delete>
</target>
@@ -38,20 +39,28 @@
</target>
<target name="tearDown" depends="clean" />
- <target name="test-easyant-plugin-documentation:report" depends="easyant-plugin-documentation:report">
+ <target name="test-easyant-plugin-documentation:init" depends="easyant-plugin-documentation:init">
<au:assertPropertyEquals name="plugindoc.module.ivy" value="${basedir}/sample-module.ivy" />
<au:assertPropertyEquals name="plugindoc.source.dir" value="${basedir}/src/main/resources" />
<au:assertPropertyEquals name="plugindoc.main.confs" value="default" />
<au:assertPropertyEquals name="target.documentation.dir" value="${target}/documentation" />
+ </target>
+
+ <target name="test-easyant-plugin-documentation:report" depends="easyant-plugin-documentation:report">
<au:assertFileExists file="${target}/documentation/org.apache.easyant.plugins-tinyplugin-default.html" />
</target>
-
+
<target name="testeasyant-plugin-documentation:package" depends="easyant-plugin-documentation:package">
<au:assertPropertyEquals name="target.artifacts" value="${target}/artifacts" />
<au:assertFileExists file="${target.artifacts}"/>
<au:assertFileExists file="${target.artifacts}/${ivy.module}-documentation.zip"/>
</target>
+ <target name="test-easyant-plugin-documentation:generate-readme" depends="easyant-plugin-documentation:generate-readme">
+ <au:assertFileExists file="${basedir}/README.md" />
+ </target>
+
+
<target name="prepare-register-artifact">
<ivy:settings id="easyant.ivy.instance" />
<ivy:resolve file="sample-module.ivy" settingsRef="easyant.ivy.instance" />
