JMS Messaging Plugin

sendCIMessage: CI Notifier

providerName

Type: String

overrides

Nested Object

topic (optional)

Type: String

messageType

Type of CI message to be sent.

Values:

  • CodeQualityChecksDone

  • ComponentBuildDone

  • Custom

  • EarlyPerformanceTestingDone

  • EarlySecurityTestingDone

  • ImageUploaded

  • FunctionalTestCoverageDone

  • FunctionalTestingDone

  • NonfunctionalTestingDone

  • OotbTestingDone

  • PeerReviewDone

  • ProductAcceptedForReleaseTesting

  • ProductBuildDone

  • ProductBuildInStaging

  • ProductTestCoverageDone

  • PullRequest

  • SecurityChecksDone

  • TestingStarted

  • TestingCompleted

  • Tier0TestingDone

  • Tier1TestingDone

  • Tier2IntegrationTestingDone

  • Tier2ValidationTestingDone

  • Tier3TestingDone

  • UnitTestCoverageDone

  • UpdateDefectStatus

    messageProperties

    KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.

Type: String

messageContent

Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

Type: String

failOnError (optional)

Whether you want to fail the build if there is an error sending a message. By default, it is false.

Type: boolean

waitForCIMessage: CI Subscriber

Subscribe to the CI message bus and wait for a message matching the specified JMS selector.

The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.

This step returns the value of the Message content as a string

node {
  def messageContent = waitForCIMessage selector: "CI_TYPE = 'code-quality-checks-done' and CI_STATUS = 'failed'"
  // The message content is now available as a variable
  echo messageContent
  // The message content is set as an environment variable
  env.messageContent = messageContent
  sh 'path/to/a/script.sh'
}

providerName

Type: String

overrides

Nested Object

topic (optional)

Type: String

selector

JMS selector use to select message to receive.

Type: String

timeout

Value (in minutes) to wait for a message matching the specified JMS selector.

Type: int