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

Checks API plugin

View this plugin on the Plugins site

publishChecks: Publish customized checks to SCM platforms

  • actions (optional)
      Array / List of Nested Object
    • label
      The label to be displayed on the checks report for this action.
      • Type: String
    • identifier
      The unique identifier for the action. Since for SCM platforms like GitHub, this is the only field that would be sent back to your Jenkins instance when an action is requested, so you may need to use this field to have more information besides the basic type of the action.
      • Type: String
    • description (optional)
      Detailed description of the action's purpose, functionality, and so on.
      • Type: String
  • annotations (optional)
      Array / List of Nested Object
    • path
      Path to the file to be annotated, started from the project root directory.
      • Type: String
    • startLine
      Start line of code to be annotated.
      • Type: int
    • endLine
      End line of code to be annotated.
      • Type: int
    • message
      A digest message of the annotation.
      • Type: String
    • annotationLevel (optional)
      Severity level of the annotation, can be one of can be "NOTICE", "WARNING", or "FAILURE"; by default, "WARNING" will be used.
      • Values: NONE, NOTICE, WARNING, FAILURE
    • endColumn (optional)
      End column of code to be annotated.
      • Type: int
    • rawDetails (optional)
      Raw details of the annotation.
      • Type: String
    • startColumn (optional)
      Start column of code to be annotated.
      • Type: int
    • title (optional)
      Title of the annotation.
      • Type: String
  • conclusion (optional)
    The conclusion of the check, can be "ACTION_REQUIRED", "SKIPPED", "CANCELED", "TIME_OUT", "FAILURE", "NEUTRAL", "SUCCESS" or "NONE". By default, "SUCCESS" will be used. When providing the conclusion other than "NONE", please make sure the status is "COMPLETED".
    • Values: NONE, ACTION_REQUIRED, SKIPPED, CANCELED, TIME_OUT, FAILURE, NEUTRAL, SUCCESS
  • detailsURL (optional)
    The URL of the site where full details can be found. When providing this parameter, make sure it is http or https scheme.
    • Type: String
  • name (optional)
    Name or identifier of the check.
    • Type: String
  • status (optional)
    The status of the check, can be "QUEUED", "IN_PROGRESS", or "COMPLETED". By default, "COMPLETED" will be used.
    • Values: NONE, QUEUED, IN_PROGRESS, COMPLETED
  • summary (optional)
    The summary of the check run. This field supports Markdown.
    • Type: String
  • text (optional)
    The details of the check. This parameter supports Markdown.
    • Type: String
  • title (optional)
    The title of the check run.
    • Type: String

withChecks: Inject checks properties into its closure

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