Build (jenkins-library 1.4.0 API)

jenkins_shared_library.pipelines.Build

This class extends Jenkins current build functions.

Example:

     // init Build instance
     def build = new Build(currentBuild)
     // show change summary
     echo build.getChangeSummary()
     // show test summary
     echo build.getTestSummary()

Properties Summary

Properties
Type	Name and description
`java.lang.Object`	`_build` Reference to the Jenkins build variable.

Constructor Summary

Constructors
Constructor and description
`Build (java.lang.Object build)` Constructs the class.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getChangeSummary()` Render list of changes for a build.
	`java.lang.String`	`getTestSummary()` Gets a test summary string.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.Object _build
    
    Reference to the Jenkins build variable.
- Constructor Detail
  - Build(java.lang.Object build)
    
    Constructs the class.
    Example:
    def build = new Build(currentBuild)
    Parameters:
    build - Normally should be "currentBuild" (org.jenkinsci.plugins.workflow.support.steps.build.RunWrapper)
- Method Detail
  - java.lang.String getChangeSummary()
    
    Render list of changes for a build.
    Note:
    This method will omit any changes reported from the shared pipeline library. These changes aren't relevant to dependent project builds so they provide no value to include.
    
    Returns:
    An HTML string that represents list of changes
  - @com.cloudbees.groovy.cps.NonCPS java.lang.String getTestSummary()
    
    Gets a test summary string.
    Note:
    This method was created using @NonCPS because some of the operations performed cannot be serialized. The @NonCPS annotation tells jenkins to not save the variable state of this function on shutdown. Failure to run in this mode causes a java.io.NotSerializableException in this method.
    
    Returns:
    An HTML string of test results.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Build

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.Object _build

Constructor Detail

Build(java.lang.Object build)

Method Detail

java.lang.String getChangeSummary()

@com.cloudbees.groovy.cps.NonCPS java.lang.String getTestSummary()