Overview

Directory artifacts are used to capture multiple files nested underneath a specified base directory. The files to capture are specified using Apache Ant style include and exclude patterns. The files captured need not be directly within the base directory, rather they may be nested at an arbitrary depth.

One use for directory artifacts is to capture HTML reports generated as part of the build. Pulse will detect if an index file is present (with name index.html, index.htm, default.html or default.htm) and will present the artifact in the web interface as appropriate.

You may also apply post-processors to directory artifacts. The post-processor is applied to each file captured as part of the artifact as they captured. This allow you to, for example, capture a directory of test reports and apply a JUnit report post-processor to them to integrate test result into the build.

Configuration

name

A descriptive name, used within the web interface to identify the artifact. This name must be unique within the project.

base directory

The path of the base directory to capture, relative to the base directory for the build. All files to be captured must be nested somewhere underneath this directory (possibly in a subdirectory). It is best to choose the most specific directory possible as it will make capturing more efficient.

This field is not required, it will default to the base directory for the build.

inclusions

A space-separated list of Ant-style patterns that specifies the files to be captured. Files matching any one of these patterns will be included in the artifact (unless excluded, see below). The pattern syntax is described on the dir-artifact page. Briefly:

• ? matches any single character.
• * matches any string of characters (including the empty string) within a single directory or filename, but does not match multiple path elements.
• ** matches any string of characters, possibly including multiple path elements.

This field is not required. By default all files nested under the directory are included.

exclusions

A space-separated list of Ant-style patterns that specifies the files to be exluded from the artifact. Files matching any one of these patterns will not be included in the artifact, even if they match an inclusion pattern. The pattern syntax is described on the dir-artifact page.

This field is not required. By default no files are excluded.

mime type

Specifies the MIME-type for captured files. This type will be passed to the web browser when the files are downloaded.

This field is not required. By default, the MIME type will be guessed from the file name and content.

post-processors

Specifies which post-processors to apply to the files captured as part of this artifact. Each of the selected processors will be applied to each captured file. The available processors are described on the Project Post-Processors page.