Post Build Index Writer Module

Available:

Bamboo 1.0 and later

On this page:

Description

The PostBuildIndexWriter allows you to write your custom data for a build into the index, which allows for future retrieval in your custom Report Module. The PostBuildIndexWriter will be invoked in three places in Bamboo: when a build completes and it indexes, operations which requires a re-index of a particular build (result), and when you run the re-index all action under the Administration tab.

The PostBuildIndexWriter should always be written in conjunction with a Index Reader Module which will be able to retrieve the data in the index.

Interface

Post Build Index Writer modules must implement the com.atlassian.bamboo.index.CustomPostBuildIndexWriter interface.

Sample Module Descriptor Element

<postBuildIndexWriter key="cloverIndexWriter" name="Write Clover Result to Index"
          class="com.atlassian.bamboo.builder.coverage.CloverPostBuildIndexWriter">
    <description>Writes the clover result in a build results to an index document</description>
  </postBuildIndexWriter>
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport