Package io.jenkins.plugins.checks.github.status

Interface GitHubStatusChecksConfigurations

All Known Implementing Classes:
GitHubSCMSourceStatusChecksTrait, GitSCMStatusChecksExtension
public interface GitHubStatusChecksConfigurations
Configurations for users to customize status checks.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Defines the status checks name which is also used as identifier for GitHub checks.
    boolean
    isSkip()
    Defines whether to skip publishing status checks.
    boolean
    isSkipProgressUpdates()
    Returns whether to suppress progress updates from the io.jenkins.plugins.checks.status.FlowExecutionAnalyzer.
    boolean
    isSuppressLogs()
    Defines whether to suppress log output in status checks.
    boolean
    isUnstableBuildNeutral()
    Defines whether to publish unstable builds as neutral status checks.

  • Method Details

    • getName

      String getName()
      Defines the status checks name which is also used as identifier for GitHub checks.
      Returns:
      the name of status checks

    • isSkip

      boolean isSkip()
      Defines whether to skip publishing status checks.
      Returns:
      true to skip publishing checks

    • isUnstableBuildNeutral

      boolean isUnstableBuildNeutral()
      Defines whether to publish unstable builds as neutral status checks.
      Returns:
      true to publish unstable builds as neutral status checks.

    • isSuppressLogs

      boolean isSuppressLogs()
      Defines whether to suppress log output in status checks.
      Returns:
      true to suppress logs

    • isSkipProgressUpdates

      boolean isSkipProgressUpdates()
      Returns whether to suppress progress updates from the io.jenkins.plugins.checks.status.FlowExecutionAnalyzer. Queued, Checkout and Completed will still run but not 'onNewHead'
      Returns:
      true if progress updates should be skipped.