> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Custom Build Properties Plugin

View this plugin on the Plugins site

getCustomBuildProperty: Get custom build property

Get a custom build property from the nearest previous build.
  • key
    • Type: String

setCustomBuildProperty: Set custom build property

Set a custom build property:
  • setCustomBuildProperty(key: 'keyString', value: 'string')
  • setCustomBuildProperty(key: 'keyString', value: 42)
  • setCustomBuildProperty(key: 'keyString', value: LocalDateTime.now())
  • ... or any other Object as value
  • key
    • Type: String
  • value
    • Type: Object
  • onlySetIfAbsent (optional)
    • Type: boolean

setJUnitCounts: Set junit test result counts as custom build properties

Set junit test result counts as custom build properties. The results are filtered by test classname using include and exclude regular expressions (see JavaDoc).

The following custom build properties will be set (prefixed with key prefix):

  • PassedCount
  • FailedCount
  • FailedAge

  • keyPrefix
    • Type: String
  • include
    • Type: String
  • exclude
    • Type: String
  • onlySetIfAbsent (optional)
    • Type: boolean

waitForCustomBuildProperties: Wait until specified custom build properties are set

Wait until specified custom build properties are set:
  • waitForCustomBuildProperties(keys: ['key1', 'key2'])
  • keys
    • Type: Array / List of String
  • timeoutTime
    • Type: int
  • timeoutUnit (optional)
    • Values: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.