Return-Path: Delivered-To: apmail-ant-notifications-archive@minotaur.apache.org Received: (qmail 11178 invoked from network); 6 Oct 2010 21:27:19 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 6 Oct 2010 21:27:19 -0000 Received: (qmail 53174 invoked by uid 500); 6 Oct 2010 21:27:19 -0000 Delivered-To: apmail-ant-notifications-archive@ant.apache.org Received: (qmail 53133 invoked by uid 500); 6 Oct 2010 21:27:19 -0000 Mailing-List: contact notifications-help@ant.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@ant.apache.org Delivered-To: mailing list notifications@ant.apache.org Received: (qmail 53125 invoked by uid 99); 6 Oct 2010 21:27:19 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 06 Oct 2010 21:27:19 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 06 Oct 2010 21:27:15 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id C53E22388CC9; Wed, 6 Oct 2010 21:25:38 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1005260 [43/45] - in /ant/ivy/site/target/history/2.2.0: ./ configuration/ configuration/caches/ configuration/macrodef/ configuration/namespace/ dev/ images/ ivyfile/ js/ resolver/ samples/ settings/ settings/caches/ settings/macrodef/ se... Date: Wed, 06 Oct 2010 21:25:35 -0000 To: notifications@ant.apache.org From: maartenc@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20101006212538.C53E22388CC9@eris.apache.org> Added: ant/ivy/site/target/history/2.2.0/use/publish.html URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/publish.html?rev=1005260&view=auto ============================================================================== --- ant/ivy/site/target/history/2.2.0/use/publish.html (added) +++ ant/ivy/site/target/history/2.2.0/use/publish.html Wed Oct 6 21:25:29 2010 @@ -0,0 +1,196 @@ + + + + + + + + +publish | Apache Ivy + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + +
+ + +
+ + +
+ + + + + + + +
+
+ +

publish

+
Publishes the current module's artifacts and the resolved descriptor (delivered ivy file).

This task is meant to publish the current module descriptor together with its declared publication artifacts to a repository.

All the artifacts must have been created before calling this task. It does not create the artifacts themselves, but expects to find them at the location indicated by the artifacts pattern.

The target repository is given through the name of a resolver declared in current ivy settings. See Settings Files for details about resolver supporting artifact publishing.

It also publishes the delivered ivy file (except if you don't want), and even del iver it, if it has not been done with a previous deliver call or if forcedeliver is set to true. That's why this task takes some parameters useful only for delivery. See the illustration below:

publish flowchart

+ +since 1.4.1 +The source artifact pattern can be specified either as an attribute on the task (artifactspattern) or using a list of nested artifacts element (see examples below).
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
organisationthe name of the organisation of the module to publishNo. Defaults to ${ivy.organisation} or the last resolved module organisation.
modulethe name of the module to publishNo. Defaults to ${ivy.module} or the last resolved module name.
revisionthe revision of the module to publish and also the published revision unless pubrevision is setNo. Defaults to ${ivy.revision} or the last resolve module revision.
artifactspatternthe pattern to use to find artifacts to publishNo. Defaults to ${ivy.publish.src.artifacts.pattern}
resolverthe name of the resolver to use for publicationYes
pubrevisionthe revision to use for the publicationNo. Defaults to the ${ivy.deliver.revision}
pubbranchthe branch to use for the publicationNo. Defaults to the ${ivy.deliver.branch}
forcedelivertrue to force the implicit call to deliver, false to do it only if the ivy file to publish doesn't exist yet (since 1.4)No. Defaults to false
updatetrue to update ivy file metadata (revision, branch, publication date and status) before publishing, false otherwise. This is usually not necessary when using deliver before publish.No. Defaults to false
mergeif this descriptor extends a parent, merge the inherited information directly into this descriptor on publish. The extends element itself will be commented out in the published descriptor. (since 2.2)No. Defaults to true
validatetrue to force ivy files validation against ivy.xsd, false to force no validationNo. Defaults to default ivy value (as configured in settings file)
replacedynamicrevtrue to replace dynamic revisions by static ones in the delivered file, false to avoid this replacement (since 1.3)No. Defaults to true
publishivyTrue to publish delivered ivy file, false otherwiseNo. Defaults to true
confA comma separated list of configurations to publish (since 1.4.1). Accepts wildcards (since 2.2).No. Defaults to all configurations
overwriteTrue to overwrite files in repository if the revision already exist, false to let it as isNo. Defaults to false
warnonmissingTrue to warn when artifacts to be published are missingNo. Defaults to true
haltonmissingTrue to halt build when artifacts to be published are missingNo. Defaults to true
srcivypatternthe pattern to use to find ivy file to publish, and even deliver if necessary (since 1.2)No. Defaults to the value of artifactspattern
pubdatethe publication date to use for the delivery, if necessary. This date should be either 'now', or a date given with the following pattern: yyyyMMddHHmmssNo. Defaults to 'now'
statusthe status to use for the delivery, if necessaryNo. Defaults to ${ivy.status}
delivertargetthe target to call for recursive deliveryNo. No recursive delivery is done by default
settingsRefA reference to the ivy settings that must be used by this task (since 2.0)No, 'ivy.instance' is taken by default.
+

Child elements

+ + + + + + + + + + + + +
ElementDescriptionCardinality
artifactDescribe additional artifacts to publish
These elements can have any attribute: standard artifact attributes and (since 2.2) extra attributes are supported.		0..n
artifactsSpecify the pattern used to find the artifact.
These elements have a pattern attribute containing the pattern used to find the artifact.		0..n
+ +

Examples

+
+<ivy:publish resolver="local" pubrevision="1.0">
   <artifacts pattern="build/artifacts/jars/[artifact].[ext]" />
   <artifacts pattern="build/artifacts/zips/[artifact].[ext]" />
</ivy:publish>
+
+Publishes the last resolved module in the local resolver with revision 1.0, looking for artifacts in directories build/artifacts/jars and build/artifacts/zips.
+
+
+ + + + + + + + + + + + +
+ + Added: ant/ivy/site/target/history/2.2.0/use/report.html URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/report.html?rev=1005260&view=auto ============================================================================== --- ant/ivy/site/target/history/2.2.0/use/report.html (added) +++ ant/ivy/site/target/history/2.2.0/use/report.html Wed Oct 6 21:25:29 2010 @@ -0,0 +1,184 @@ + + + + + + + + +report | Apache Ivy + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + +
+ + +
+ + +
+ + + + + + + +
+
+ +

report

+
Generates reports of dependency resolving. One report per configuration is generated, but all reports generated together are hyperlinked one to each other.

This task should be used only after a call to resolve, even if the call was not done during the same ant build.
In fact, this task uses xml report generated by resolve in cache. So if you call resolve on a module for a given configuration, you can call report safely on this module and this configuration as long as you do not clean your ivy cache.

If you want to have an idea of what reports look like, check this very simple example.
The task also generates a graphml file which can be loaded with the free yEd graph editor.
Then following a few simple steps you can obtain a graph like this one.
+
since 1.4
If a custom XSL is specified, it's possible to specify additional parameters to the stylesheet.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
todirthe directory to which reports should be generatedNo, defaults to ${ivy.report.todir}, or execution directory if not defined
outputpatternthe generated report names patternNo, defaults to ${ivy.report.output.pattern}, or [organisation]-[module]-[conf].[ext] if not defined
xsltrue to generate a report (by default html report) using xslt, false otherwise since 1.3No, defaults to true
xmltrue to generate a xml report, false otherwise since 1.3No, defaults to false
graphtrue to generate graphml files, false otherwiseNo, defaults to true
dottrue to generate graphviz dot files, false otherwise since 1.4No, defaults to false
confa comma separated list of the configurations for which a report should be generatedNo. Defaults to the configurations resolved by the last resolve call (during same ant build), or ${ivy.resolved.configurations} if no resolve was called
organisationthe name of the organisation of the module for which report should be generatedNo, unless resolveId has not been specified and no resolve was called during the build. Defaults to last resolved module organisation.
modulethe name of the module for which report should be generatedNo, unless resolveId has not been specified and no resolve was called during the build. Defaults to last resolved module.
validatetrue to force ivy files validation against ivy.xsd, false to force no validationNo. Defaults to default ivy value (as configured in configuration file)
xslfileindicates which xsl file should be used to generate the reportNo, defaults to ivy provided xsl which generates html report
settingsRefA reference to the ivy settings that must be used by this task (since 2.0)No, 'ivy.instance' is taken by default.
resolveIdThe id which was used for a previous resolve (since 2.0)No, defaults to '[org]-[module]'.
+ +

Examples

+To generate a HTML and graphml report: +
+<report conf="compile" />
+
+ +
+To generate a HTML report only: +
+<report conf="compile" graph="false" />
+
+ +
+To generate an XML report using a custom stylesheet: +
+<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml" />
+
+ +To generate an XML report using a custom stylesheet which needs some parameters: +
+<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml">
    <param name="param1" expression="value1" /> 
    <param name="param2" expression="value2" /> 
</report>
+
+ + +
+
+ + + + + + + + + + + + +
+ + Added: ant/ivy/site/target/history/2.2.0/use/repreport.html URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/repreport.html?rev=1005260&view=auto ============================================================================== --- ant/ivy/site/target/history/2.2.0/use/repreport.html (added) +++ ant/ivy/site/target/history/2.2.0/use/repreport.html Wed Oct 6 21:25:29 2010 @@ -0,0 +1,202 @@ + + + + + + + + +repreport | Apache Ivy + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + +
+ + +
+ + +
+ + + + + + + +
+
+ +

repreport

+
Generates reports about dependencies among several modules in the repository (repreport stands for repository report).since 1.4 + +This task is similar to the report task, except that instead of working on a single module you just resolved, it works with a set of modules in your repository.

Note that the set of modules for which you generate the report is determined by setting organisation module and revision and using a matcher, but also by the dependencies of these modules. No dependency is excluded.

Usually the most useful report is a graph, you can generate either a graphml file that you can then easily layout using yEd, or a dot file which is the format recognized by graphviz, which is a free tool which does automatic graph layout, and can thus be used to generate automatically a GIF or PNG of the dependencies between all your modules.

Limitation: this task requires to be able to browse the reposi tory, and is thus limited to resolvers supporting repository listing. In particular, it means it doesn't work to report all organizations in a repository using m2compatible mode.
Moreover, to be able to list organizations, this task requires an [organisation] token in the resolver(s) used.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
organisationA pattern matching the organisation of the modules for which the report should be generatedNo, defaults to '*'
moduleA pattern matching the name of the modules for which the report should be generatedNo, defaults to '*'
branchThe name of the branch of the modules for which the report should be generatedNo, defaults to no branch specified
revisionThe revision of the modules for which the report should be generated. Only one revision per module will be used, so most of the time keeping the default (latest.integration) is the best thing to do, because it's not very easy to specify only one revision for several modules.No, defaults to 'latest.integration'
todirthe directory to which reports should be generatedNo, defaults to execution directory
outputnamethe name to use for the generate file (without extension)No, defaults to ivy-repository-report
xmltrue to generate a xml report, false otherwiseNo, defaults to true
xsltrue to generate a report using xslt, false otherwiseNo, defaults to false
xslfileindicates which xsl file should be used to generate the reportYes if you want to use xsl transformation
xslextindicates the extension to use when generating report using xslNo defaults to 'html'
graphtrue to generate graphml file, false otherwiseNo, defaults to false
dottrue to generate graphviz dot format file, false otherwiseNo, defaults to false
matcherthe name of the matcher to use for matching modules names and organisations in your repositoryNo. Defaults to exactOrRegexp
validatetrue to force ivy files validation against ivy.xsd, false to force no validationNo. Defaults to default ivy value (as configured in configuration file)
settingsRefA reference to the ivy settings that must be used by this task (since 2.0)No, 'ivy.instance' is taken by default.
+ +

Examples

+To generate a xml report for all the latest versions of all the modules in your repository: +
+<ivy:repreport />
+
+ +
+To generate a graphml report for all the latest versions of all the modules in your repository: +
+<ivy:repreport xml="false" graph="true" />
+
+ +
+To generate a xml report for all the latest versions of the modules from the organisation foo in your repository: +
+<ivy:repreport organisation="foo" />
+
+ +
+To generate a xml report for all the versions on the 1.x stream of the modules named bar* from the organisation foo in your repository: +
+<ivy:repreport organisation="foo" module="bar*" revision="1.+" matcher="glob" />
+
+ +
+To generate an XML report using a custom stylesheet: +
+<ivy:repreport xsl="true" xslfile="my-custom-stylesheet.xsl" xslext="xml" />
+
+ +
+To generate an XML report using a custom stylesheet which needs some parameters: +
+<ivy:repreport xsl="true" xslfile="my-custom-stylesheet.xsl" xslext="xml">
    <param name="param1" expression="value1" /> 
    <param name="param2" expression="value2" /> 
</report>
+
+ + +
+
+ + + + + + + + + + + + +
+ +