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

Class GitSCMStatusChecksExtension

java.lang.Object
hudson.model.AbstractDescribableImpl<hudson.plugins.git.extensions.GitSCMExtension>
hudson.plugins.git.extensions.GitSCMExtension
io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
All Implemented Interfaces:
Describable<hudson.plugins.git.extensions.GitSCMExtension>, GitHubStatusChecksConfigurations
public class GitSCMStatusChecksExtension extends hudson.plugins.git.extensions.GitSCMExtension implements GitHubStatusChecksConfigurations
Git Extension that controls AbstractStatusChecksProperties for freestyle jobs using GitSCM.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    GitSCMStatusChecksExtension.DescriptorImpl
    Descriptor implementation for GitSCMStatusChecksExtension.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GitSCMStatusChecksExtension()
    Constructor for stapler.

  • 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.
    void
    setName(String name)
    Set the name of the status checks.
    void
    setSkip(boolean skip)
    Set if skip publishing status checks.
    void
    setSkipProgressUpdates(boolean skipProgressUpdates)
     
    void
    setSuppressLogs(boolean suppressLogs)
     
    void
    setUnstableBuildNeutral(boolean unstableBuildNeutral)
     

    Methods inherited from class hudson.plugins.git.extensions.GitSCMExtension

    beforeCheckout, beforeCheckout, decorate, decorateCheckoutCommand, decorateCheckoutCommand, decorateCloneCommand, decorateCloneCommand, decorateFetchCommand, decorateFetchCommand, decorateMergeCommand, decorateMergeCommand, decorateRevisionToBuild, decorateRevisionToBuild, determineSupportForJGit, enableMultipleRevisionDetection, getDescriptor, getRequiredClient, getWorkingDirectory, getWorkingDirectory, isRevExcluded, onCheckoutCompleted, onCheckoutCompleted, onClean, populateEnvironmentVariables, requiresWorkspaceForPolling

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GitSCMStatusChecksExtension

      @DataBoundConstructor public GitSCMStatusChecksExtension()
      Constructor for stapler.

  • Method Details

    • getName

      public String getName()
      Description copied from interface: GitHubStatusChecksConfigurations
      Defines the status checks name which is also used as identifier for GitHub checks.
      Specified by:
      getName in interface GitHubStatusChecksConfigurations
      Returns:
      the name of status checks

    • isSkip

      public boolean isSkip()
      Description copied from interface: GitHubStatusChecksConfigurations
      Defines whether to skip publishing status checks.
      Specified by:
      isSkip in interface GitHubStatusChecksConfigurations
      Returns:
      true to skip publishing checks

    • isUnstableBuildNeutral

      public boolean isUnstableBuildNeutral()
      Description copied from interface: GitHubStatusChecksConfigurations
      Defines whether to publish unstable builds as neutral status checks.
      Specified by:
      isUnstableBuildNeutral in interface GitHubStatusChecksConfigurations
      Returns:
      true to publish unstable builds as neutral status checks.

    • isSuppressLogs

      public boolean isSuppressLogs()
      Description copied from interface: GitHubStatusChecksConfigurations
      Defines whether to suppress log output in status checks.
      Specified by:
      isSuppressLogs in interface GitHubStatusChecksConfigurations
      Returns:
      true to suppress logs

    • isSkipProgressUpdates

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

    • setSkipProgressUpdates

      @DataBoundSetter public void setSkipProgressUpdates(boolean skipProgressUpdates)

    • setName

      @DataBoundSetter public void setName(String name)
      Set the name of the status checks.
      Parameters:
      name - name of the checks

    • setSkip

      @DataBoundSetter public void setSkip(boolean skip)
      Set if skip publishing status checks.
      Parameters:
      skip - true if skip

    • setUnstableBuildNeutral

      @DataBoundSetter public void setUnstableBuildNeutral(boolean unstableBuildNeutral)

    • setSuppressLogs

      @DataBoundSetter public void setSuppressLogs(boolean suppressLogs)