Class GitHubSCMSourceStatusChecksTrait
java.lang.Object
hudson.model.AbstractDescribableImpl<T>
jenkins.scm.api.trait.SCMTrait<jenkins.scm.api.trait.SCMSourceTrait>
jenkins.scm.api.trait.SCMSourceTrait
io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- All Implemented Interfaces:
ExtensionPoint
,Describable<jenkins.scm.api.trait.SCMSourceTrait>
,GitHubStatusChecksConfigurations
public class GitHubSCMSourceStatusChecksTrait
extends jenkins.scm.api.trait.SCMSourceTrait
implements GitHubStatusChecksConfigurations
Traits to control
AbstractStatusChecksProperties
for jobs using
GitHubSCMSource
.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Descriptor implementation forGitHubSCMSourceStatusChecksTrait
.Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
decorateContext
(jenkins.scm.api.trait.SCMSourceContext<?, ?> context) 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
Defines whether to skip notifications fromGitHubBuildStatusNotification
which utilizes the GitHub Status API.boolean
Returns whether to suppress progress updates from theio.jenkins.plugins.checks.status.FlowExecutionAnalyzer
.boolean
Defines whether to suppress log output in status checks.boolean
Defines whether to publish unstable builds as neutral status checks.void
Set the name of the status checks.void
setSkip
(boolean skip) Set if skip publishing status checks.void
setSkipNotifications
(boolean skipNotifications) void
setSkipProgressUpdates
(boolean skipProgressUpdates) void
setSuppressLogs
(boolean suppressLogs) void
setUnstableBuildNeutral
(boolean unstableBuildNeutral) Methods inherited from class jenkins.scm.api.trait.SCMSourceTrait
_for, _for, all, applyToBuilder, applyToContext, applyToObserver, decorateBuilder, decorateObserver, getDescriptor, includeCategory, isCategoryEnabled
Methods inherited from class jenkins.scm.api.trait.SCMTrait
asSetList, asSetList, find
-
Constructor Details
-
GitHubSCMSourceStatusChecksTrait
@DataBoundConstructor public GitHubSCMSourceStatusChecksTrait()Constructor for stapler.
-
-
Method Details
-
getName
Defines the status checks name which is also used as identifier for GitHub checks.- Specified by:
getName
in interfaceGitHubStatusChecksConfigurations
- Returns:
- the name of status checks
-
isSkip
public boolean isSkip()Defines whether to skip publishing status checks.- Specified by:
isSkip
in interfaceGitHubStatusChecksConfigurations
- 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 interfaceGitHubStatusChecksConfigurations
- Returns:
- true to publish unstable builds as neutral status checks.
-
isSkipNotifications
public boolean isSkipNotifications()Defines whether to skip notifications fromGitHubBuildStatusNotification
which utilizes the GitHub Status API.- Returns:
- true to skip notifications
-
isSuppressLogs
public boolean isSuppressLogs()Description copied from interface:GitHubStatusChecksConfigurations
Defines whether to suppress log output in status checks.- Specified by:
isSuppressLogs
in interfaceGitHubStatusChecksConfigurations
- Returns:
- true to suppress logs
-
isSkipProgressUpdates
public boolean isSkipProgressUpdates()Description copied from interface:GitHubStatusChecksConfigurations
Returns whether to suppress progress updates from theio.jenkins.plugins.checks.status.FlowExecutionAnalyzer
. Queued, Checkout and Completed will still run but not 'onNewHead'- Specified by:
isSkipProgressUpdates
in interfaceGitHubStatusChecksConfigurations
- Returns:
- true if progress updates should be skipped.
-
setSkipProgressUpdates
@DataBoundSetter public void setSkipProgressUpdates(boolean skipProgressUpdates) -
setName
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) -
setSkipNotifications
@DataBoundSetter public void setSkipNotifications(boolean skipNotifications) -
setSuppressLogs
@DataBoundSetter public void setSuppressLogs(boolean suppressLogs) -
decorateContext
protected void decorateContext(jenkins.scm.api.trait.SCMSourceContext<?, ?> context) - Overrides:
decorateContext
in classjenkins.scm.api.trait.SCMSourceTrait
-