doc/use/artifactreport.html - ant-ivy - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <!--
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 -->
 <html>
 <head>
 	<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
 	<script type="text/javascript">var xookiConfig = {level: 1};</script>
 	<script type="text/javascript" src="../xooki/xooki.js"></script>
 </head>
 <body>
 	<textarea id="xooki-source">
 <span class="since">since 1.4</span>
 The artifactreport task generates an xml report of all artifacts dependencies resolved by the last <a href="../use/resolve.html">resolve</a> task call during the same build.

 <span class="since">since 2.0</span> This is a [[ant:postresolvetask post resolve task]], with all the behaviour and attributes common to all post resolve tasks.

 This report is different from the standard <a href="../use/report.html">report</a> which reports all modules and artifacts, whle this report is much simpler and focuses only on artifacts, and gives more information on artifacts, such as the original location and the retrieve location.

 It is thus easy to use to generate things like a classpath file for an IDE.

 See this <a href="http://www.jaya.free.fr/ivy/doc/articles/ease-multi-module.html">article by Johan Stuyts</a> (who contributed this task) to see how he uses this task.

 Here is an example of generate file:
 <code type="xml">
 <?xml version="1.0" encoding="UTF-8"?>
 <modules>
   <module organisation="hippo" name="sant-classes" rev="1.01.00b04-dev" status="integration">
     <artifact name="sant-classes-src" ext="zip" type="zip">
       <origin-location is-local="true">
         C:/home/jstuyts/data/ivy/local/hippo/sant-classes/1.01.00b04-dev/sant-classes-src-1.01.00b04-dev.zip</origin-location>
       <cache-location>
         C:/home/jstuyts/data/ivy/cache/hippo/sant-classes/zips/sant-classes-src-1.01.00b04-dev.zip</cache-location>
       <retrieve-location>lib/test/sant-classes-src-1.01.00b04-dev.zip</retrieve-location>
     </artifact>
     <artifact name="sant-classes-unoptimized" ext="jar" type="jar">
       <origin-location is-local="true">
         C:/home/jstuyts/data/ivy/local/hippo/sant-classes/1.01.00b04-dev/sant-classes-unoptimized-1.01.00b04-dev.jar</origin-location>
       <cache-location>
         C:/home/jstuyts/data/ivy/cache/hippo/sant-classes/jars/sant-classes-unoptimized-1.01.00b04-dev.jar</cache-location>
       <retrieve-location>lib/test/sant-classes-unoptimized-1.01.00b04-dev.jar</retrieve-location>
     </artifact>
   </module>
   <module organisation="testng" name="testng" rev="4.6.1-jdk15" status="release">
     <artifact name="testng" ext="jar" type="jar">
       <origin-location is-local="false">
         http://repository.hippocms.org/maven/testng/jars/testng-4.6.1-jdk15.jar</origin-location>
       <cache-location>C:/home/jstuyts/data/ivy/cache/testng/testng/jars/testng-4.6.1-jdk15.jar</cache-location>
       <retrieve-location>lib/test/testng-4.6.1-jdk15.jar</retrieve-location>
     </artifact>
   </module>
 </code>

 <h1>Attributes</h1>
 <table class="ant">
 <thead>
     <tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
 </thead>
 <tbody>
     <tr><td>tofile</td><td>the file to which the report should be written</td>
         <td>Yes</td></tr>
     <tr><td>pattern</td><td>the retrieve pattern to use to fill the retrieve location information about the artifacts</td>
         <td>No. Defaults to ${ivy.retrieve.pattern}.</td></tr>
     <tr><td>conf</td><td>a comma separated list of the configurations to use to generate the report</td>
         <td>No. Defaults to the configurations resolved by the last resolve call</td></tr>
     <tr><td>haltonfailure</td><td>true to halt the build on ivy failure, false to continue</td><td>No. Defaults to true</td></tr>
     <tr><td>settingsRef</td><td>A reference to the ivy settings that must be used by this task <b>(since 2.0)</b></td><td>No, 'ivy.instance' is taken by default.</td></tr>
 </tbody>
 </table>
 <h1>Examples</h1>
 <code type="xml">
 <ivy:artifactreport tofile="${basedir}/path/to/myreport.xml" />
 </code>
 Generates the artifact report for all configurations resolved during the last resolve call (in the same build).

 <code type="xml">
 <ivy:artifactreport tofile="${basedir}/path/to/myreport.xml" conf="default"/>
 </code>
 Generates the artifact report for only the default configuration resolved during the last resolve call.

 	</textarea>
 <script type="text/javascript">xooki.postProcess();</script>
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->
	<html>
	<head>
	<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
	<script type="text/javascript">var xookiConfig = {level: 1};</script>
	<script type="text/javascript" src="../xooki/xooki.js"></script>
	</head>
	<body>
	<textarea id="xooki-source">
	<span class="since">since 1.4</span>
	The artifactreport task generates an xml report of all artifacts dependencies resolved by the last <a href="../use/resolve.html">resolve</a> task call during the same build.

	<span class="since">since 2.0</span> This is a [[ant:postresolvetask post resolve task]], with all the behaviour and attributes common to all post resolve tasks.

	This report is different from the standard <a href="../use/report.html">report</a> which reports all modules and artifacts, whle this report is much simpler and focuses only on artifacts, and gives more information on artifacts, such as the original location and the retrieve location.

	It is thus easy to use to generate things like a classpath file for an IDE.

	See this <a href="http://www.jaya.free.fr/ivy/doc/articles/ease-multi-module.html">article by Johan Stuyts</a> (who contributed this task) to see how he uses this task.

	Here is an example of generate file:
	<code type="xml">
	<?xml version="1.0" encoding="UTF-8"?>
	<modules>
	<module organisation="hippo" name="sant-classes" rev="1.01.00b04-dev" status="integration">
	<artifact name="sant-classes-src" ext="zip" type="zip">
	<origin-location is-local="true">
	C:/home/jstuyts/data/ivy/local/hippo/sant-classes/1.01.00b04-dev/sant-classes-src-1.01.00b04-dev.zip</origin-location>
	<cache-location>
	C:/home/jstuyts/data/ivy/cache/hippo/sant-classes/zips/sant-classes-src-1.01.00b04-dev.zip</cache-location>
	<retrieve-location>lib/test/sant-classes-src-1.01.00b04-dev.zip</retrieve-location>
	</artifact>
	<artifact name="sant-classes-unoptimized" ext="jar" type="jar">
	<origin-location is-local="true">
	C:/home/jstuyts/data/ivy/local/hippo/sant-classes/1.01.00b04-dev/sant-classes-unoptimized-1.01.00b04-dev.jar</origin-location>
	<cache-location>
	C:/home/jstuyts/data/ivy/cache/hippo/sant-classes/jars/sant-classes-unoptimized-1.01.00b04-dev.jar</cache-location>
	<retrieve-location>lib/test/sant-classes-unoptimized-1.01.00b04-dev.jar</retrieve-location>
	</artifact>
	</module>
	<module organisation="testng" name="testng" rev="4.6.1-jdk15" status="release">
	<artifact name="testng" ext="jar" type="jar">
	<origin-location is-local="false">
	http://repository.hippocms.org/maven/testng/jars/testng-4.6.1-jdk15.jar</origin-location>
	<cache-location>C:/home/jstuyts/data/ivy/cache/testng/testng/jars/testng-4.6.1-jdk15.jar</cache-location>
	<retrieve-location>lib/test/testng-4.6.1-jdk15.jar</retrieve-location>
	</artifact>
	</module>
	</code>

	<h1>Attributes</h1>
	<table class="ant">
	<thead>
	<tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
	</thead>
	<tbody>
	<tr><td>tofile</td><td>the file to which the report should be written</td>
	<td>Yes</td></tr>
	<tr><td>pattern</td><td>the retrieve pattern to use to fill the retrieve location information about the artifacts</td>
	<td>No. Defaults to ${ivy.retrieve.pattern}.</td></tr>
	<tr><td>conf</td><td>a comma separated list of the configurations to use to generate the report</td>
	<td>No. Defaults to the configurations resolved by the last resolve call</td></tr>
	<tr><td>haltonfailure</td><td>true to halt the build on ivy failure, false to continue</td><td>No. Defaults to true</td></tr>
	<tr><td>settingsRef</td><td>A reference to the ivy settings that must be used by this task <b>(since 2.0)</b></td><td>No, 'ivy.instance' is taken by default.</td></tr>
	</tbody>
	</table>
	<h1>Examples</h1>
	<code type="xml">
	<ivy:artifactreport tofile="${basedir}/path/to/myreport.xml" />
	</code>
	Generates the artifact report for all configurations resolved during the last resolve call (in the same build).

	<code type="xml">
	<ivy:artifactreport tofile="${basedir}/path/to/myreport.xml" conf="default"/>
	</code>
	Generates the artifact report for only the default configuration resolved during the last resolve call.

	</textarea>
	<script type="text/javascript">xooki.postProcess();</script>
	</body>
	</html>