> 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.

Rich Text Publisher Plugin

View this plugin on the Plugins site

rtp: Publish rich text message

  • abortedAsStable (optional)
    When selected, the same text block is used for stable and aborted builds.
    • Type: boolean
  • abortedText (optional)

    Specify rich text to be published on build and job summary pages for aborted builds. This text will be used only if "The same text for aborted builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.

    Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).

    • Type: String
  • failedAsStable (optional)
    When selected, the same text block is used for stable and failed builds.
    • Type: boolean
  • failedText (optional)

    Specify rich text to be published on build and job summary pages for failed builds. This text will be used only if "The same text for failed builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.

    Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).

    • Type: String
  • nullAction (optional)

    Select what happens in the case that the buildstate is null or unknown

    • Type: String
  • parserName (optional)
    • Type: String
  • stableText (optional)

    Specify rich text to be published on build and job summary pages for stable and (if corresponding checkboxes are selected) for unstable and failed builds. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.

    Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).

    • Type: String
  • unstableAsStable (optional)
    When selected, the same text block is used for stable and unstable builds.
    • Type: boolean
  • unstableText (optional)

    Specify rich text to be published on build anyd job summary pages for unstable builds. This text will be used only if "The same text for unstable builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.

    Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).

    • Type: String

step([$class: 'RichTextPublisher']): Publish rich text message

  • stableText

    Specify rich text to be published on build and job summary pages for stable and (if corresponding checkboxes are selected) for unstable and failed builds. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.

    Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).

    • Type: String
  • unstableText

    Specify rich text to be published on build anyd job summary pages for unstable builds. This text will be used only if "The same text for unstable builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.

    Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).

    • Type: String
  • failedText

    Specify rich text to be published on build and job summary pages for failed builds. This text will be used only if "The same text for failed builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.

    Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).

    • Type: String
  • abortedText

    Specify rich text to be published on build and job summary pages for aborted builds. This text will be used only if "The same text for aborted builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.

    Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).

    • Type: String
  • unstableAsStable
    When selected, the same text block is used for stable and unstable builds.
    • Type: boolean
  • failedAsStable
    When selected, the same text block is used for stable and failed builds.
    • Type: boolean
  • abortedAsStable
    When selected, the same text block is used for stable and aborted builds.
    • Type: boolean
  • parserName
    • Type: String
  • nullAction

    Select what happens in the case that the buildstate is null or unknown

    • Type: String

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.