Index
All Classes and Interfaces|All Packages
C
- CheckRunGHEventSubscriber - Class in io.jenkins.plugins.checks.github
-
This subscriber manages
GHEvent.CHECK_RUN
event and handles the re-run action request. - CheckRunGHEventSubscriber() - Constructor for class io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber
-
Construct the subscriber.
- CheckRunGHEventSubscriber.GitHubChecksRerunActionCause - Class in io.jenkins.plugins.checks.github
-
Declares that a build was started due to a user's rerun request through GitHub checks API.
- createPublisher(Job<?, ?>, TaskListener) - Method in class io.jenkins.plugins.checks.github.GitHubChecksPublisherFactory
- createPublisher(Run<?, ?>, TaskListener) - Method in class io.jenkins.plugins.checks.github.GitHubChecksPublisherFactory
D
- decorateContext(SCMSourceContext<?, ?>) - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- DefaultGitHubChecksConfig - Class in io.jenkins.plugins.checks.github.config
-
Default implementation for
GitHubChecksConfig
. - DefaultGitHubChecksConfig() - Constructor for class io.jenkins.plugins.checks.github.config.DefaultGitHubChecksConfig
- DescriptorImpl() - Constructor for class io.jenkins.plugins.checks.github.config.GitHubSCMSourceChecksTrait.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.checks.github.config.GitSCMChecksExtension.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension.DescriptorImpl
- doCheckName(String) - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait.DescriptorImpl
-
Checks if the name of status checks is valid.
- doCheckName(String) - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension.DescriptorImpl
-
Checks if the name of status checks is valid.
E
- events() - Method in class io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber
F
- findGitHubAppCredentials(Job<?, ?>, String) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Find
GitHubAppCredentials
with thecredentialsId
used by thejob
. - findGitHubSCMSource(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Find
GitHubSCMSource
(or GitHub repository) used by thejob
. - findGitSCM(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Finds the
GitSCM
used by thejob
. - findGitSCM(Run<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Finds the
GitSCM
used by therun
. - findGitSCMSource(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Find
GitSCMSource
used by thejob
. - findHash(SCMRevision) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Find the hash value in
revision
. - findHead(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Find
SCMHead
(or branch) used by thejob
. - findRevision(SCMSource, SCMHead) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Fetch the current
SCMRevision
used by thehead
of thesource
. - findRevision(GitHubSCMSource, Run<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Find the current
SCMRevision
of thesource
andrun
locally throughSCMRevisionAction
. - findSCMSource(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Find
GitHubSCMSource
(or GitHub repository) used by thejob
.
G
- getBranchName() - Method in class io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber.GitHubChecksRerunActionCause
- getContextClass() - Method in class io.jenkins.plugins.checks.github.config.GitHubSCMSourceChecksTrait.DescriptorImpl
-
The
GitHubSCMSourceChecksTrait
is only applicable toGitHubSCMSourceContext
. - getContextClass() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait.DescriptorImpl
-
The
GitHubSCMSourceStatusChecksTrait
is only applicable toGitHubSCMSourceContext
. - getCredentials() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
-
Returns the credentials to access the remote GitHub repository.
- getCredentialsId() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
- getDisplayName() - Method in class io.jenkins.plugins.checks.github.config.GitHubSCMSourceChecksTrait.DescriptorImpl
-
Returns the display name.
- getDisplayName() - Method in class io.jenkins.plugins.checks.github.config.GitSCMChecksExtension.DescriptorImpl
-
Returns the display name.
- getDisplayName() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait.DescriptorImpl
-
Returns the display name.
- getDisplayName() - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension.DescriptorImpl
-
Returns the display name.
- getGitHubAppCredentials(String) - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
- getHeadSha() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
-
Returns the commit sha of the run.
- getId() - Method in class io.jenkins.plugins.checks.github.GitHubChecksAction
- getId(String) - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
-
Returns the id of a
GitHubChecksAction
for this run, if any. - getJob() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
- getName() - Method in class io.jenkins.plugins.checks.github.GitHubChecksAction
- getName() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
-
Defines the status checks name which is also used as identifier for GitHub checks.
- getName() - Method in interface io.jenkins.plugins.checks.github.status.GitHubStatusChecksConfigurations
-
Defines the status checks name which is also used as identifier for GitHub checks.
- getName() - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
- getName(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.status.GitHubStatusChecksProperties
- getRepository() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
-
Returns the source repository's full name of the run.
- getRun() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
- getScm(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Returns the SCM in a given job.
- getScm(Run<?, ?>) - Method in class io.jenkins.plugins.checks.github.SCMFacade
-
Returns the SCM in a given build.
- getScmFacade() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
- getShortDescription() - Method in class io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber.GitHubChecksRerunActionCause
- getSourceClass() - Method in class io.jenkins.plugins.checks.github.config.GitHubSCMSourceChecksTrait.DescriptorImpl
-
The
GitHubSCMSourceChecksTrait
is only applicable toGitHubSCMSource
. - getSourceClass() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait.DescriptorImpl
-
The
GitHubSCMSourceStatusChecksTrait
is only applicable toGitHubSCMSource
. - getURL() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
-
Returns the URL of the run's summary page, e.g.
- GitHubChecksAction - Class in io.jenkins.plugins.checks.github
-
An invisible action to track the state of GitHub Checks so that the publisher can update existing checks by the same name, and report back to the checks api the state of a named check (without having to go and check GitHub each time).
- GitHubChecksAction(long, String) - Constructor for class io.jenkins.plugins.checks.github.GitHubChecksAction
-
Construct a
GitHubChecksAction
with the given details. - GitHubChecksConfig - Interface in io.jenkins.plugins.checks.github.config
-
Project-level configurations for users to customize GitHub checks.
- GitHubChecksContext - Class in io.jenkins.plugins.checks.github
-
Base class for a context that publishes GitHub checks.
- GitHubChecksContext(Job<?, ?>, String, SCMFacade) - Constructor for class io.jenkins.plugins.checks.github.GitHubChecksContext
- GitHubChecksPublisher - Class in io.jenkins.plugins.checks.github
-
A publisher which publishes GitHub check runs.
- GitHubChecksPublisher(GitHubChecksContext, PluginLogger) - Constructor for class io.jenkins.plugins.checks.github.GitHubChecksPublisher
-
Creates a new instance of GitHubChecksPublisher.
- GitHubChecksPublisherFactory - Class in io.jenkins.plugins.checks.github
-
An factory which produces
GitHubChecksPublisher
. - GitHubChecksPublisherFactory() - Constructor for class io.jenkins.plugins.checks.github.GitHubChecksPublisherFactory
-
Creates a new instance of
GitHubChecksPublisherFactory
. - GitHubChecksRerunActionCause(String, String) - Constructor for class io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber.GitHubChecksRerunActionCause
-
Construct the cause with user who requested the rerun.
- GitHubSCMSourceChecksTrait - Class in io.jenkins.plugins.checks.github.config
-
GitHub checks configurations for jobs with
GitHubSCMSource
. - GitHubSCMSourceChecksTrait() - Constructor for class io.jenkins.plugins.checks.github.config.GitHubSCMSourceChecksTrait
-
Constructor for stapler.
- GitHubSCMSourceChecksTrait.DescriptorImpl - Class in io.jenkins.plugins.checks.github.config
-
Descriptor implementation for
GitHubSCMSourceChecksTrait
. - GitHubSCMSourceStatusChecksTrait - Class in io.jenkins.plugins.checks.github.status
-
Traits to control
AbstractStatusChecksProperties
for jobs usingGitHubSCMSource
. - GitHubSCMSourceStatusChecksTrait() - Constructor for class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
-
Constructor for stapler.
- GitHubSCMSourceStatusChecksTrait.DescriptorImpl - Class in io.jenkins.plugins.checks.github.status
-
Descriptor implementation for
GitHubSCMSourceStatusChecksTrait
. - GitHubStatusChecksConfigurations - Interface in io.jenkins.plugins.checks.github.status
-
Configurations for users to customize status checks.
- GitHubStatusChecksProperties - Class in io.jenkins.plugins.checks.github.status
-
Implementing
AbstractStatusChecksProperties
to retrieve properties from jobs withGitHubSCMSource
,GitSCM
, orGitSCMSource
. - GitHubStatusChecksProperties() - Constructor for class io.jenkins.plugins.checks.github.status.GitHubStatusChecksProperties
-
Default Constructor.
- GitSCMChecksExtension - Class in io.jenkins.plugins.checks.github.config
-
GitHub checks configurations for freestyle jobs with
GitSCM
. - GitSCMChecksExtension() - Constructor for class io.jenkins.plugins.checks.github.config.GitSCMChecksExtension
-
Constructor for stapler.
- GitSCMChecksExtension.DescriptorImpl - Class in io.jenkins.plugins.checks.github.config
-
Descriptor for
GitSCMChecksExtension
. - GitSCMStatusChecksExtension - Class in io.jenkins.plugins.checks.github.status
-
Git Extension that controls
AbstractStatusChecksProperties
for freestyle jobs usingGitSCM
. - GitSCMStatusChecksExtension() - Constructor for class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
-
Constructor for stapler.
- GitSCMStatusChecksExtension.DescriptorImpl - Class in io.jenkins.plugins.checks.github.status
-
Descriptor implementation for
GitSCMStatusChecksExtension
.
H
- hasCredentialsId() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
- hasGitHubAppCredentials() - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
- hasValidCredentials(FilteredLog) - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
I
- io.jenkins.plugins.checks.github - package io.jenkins.plugins.checks.github
-
Provides default Findbugs annotations.
- io.jenkins.plugins.checks.github.config - package io.jenkins.plugins.checks.github.config
- io.jenkins.plugins.checks.github.status - package io.jenkins.plugins.checks.github.status
- isApplicable(Item) - Method in class io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber
- isApplicable(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.status.GitHubStatusChecksProperties
- isSkip() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
-
Defines whether to skip publishing status checks.
- isSkip() - Method in interface io.jenkins.plugins.checks.github.status.GitHubStatusChecksConfigurations
-
Defines whether to skip publishing status checks.
- isSkip() - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
- isSkipNotifications() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
-
Defines whether to skip notifications from
GitHubBuildStatusNotification
which utilizes the GitHub Status API. - isSkipped(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.status.GitHubStatusChecksProperties
- isSkipProgressUpdates() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- isSkipProgressUpdates() - Method in interface io.jenkins.plugins.checks.github.status.GitHubStatusChecksConfigurations
-
Returns whether to suppress progress updates from the
io.jenkins.plugins.checks.status.FlowExecutionAnalyzer
. - isSkipProgressUpdates() - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
- isSkipProgressUpdates(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.status.GitHubStatusChecksProperties
- isSuppressLogs() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- isSuppressLogs() - Method in interface io.jenkins.plugins.checks.github.status.GitHubStatusChecksConfigurations
-
Defines whether to suppress log output in status checks.
- isSuppressLogs() - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
- isSuppressLogs(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.status.GitHubStatusChecksProperties
- isUnstableBuildNeutral() - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- isUnstableBuildNeutral() - Method in interface io.jenkins.plugins.checks.github.status.GitHubStatusChecksConfigurations
-
Defines whether to publish unstable builds as neutral status checks.
- isUnstableBuildNeutral() - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
- isUnstableBuildNeutral(Job<?, ?>) - Method in class io.jenkins.plugins.checks.github.status.GitHubStatusChecksProperties
- isValid(FilteredLog) - Method in class io.jenkins.plugins.checks.github.GitHubChecksContext
-
Returns whether the context is valid (with all properties functional) to use.
- isVerboseConsoleLog() - Method in class io.jenkins.plugins.checks.github.config.DefaultGitHubChecksConfig
- isVerboseConsoleLog() - Method in interface io.jenkins.plugins.checks.github.config.GitHubChecksConfig
-
Defines whether to output verbose console log.
- isVerboseConsoleLog() - Method in class io.jenkins.plugins.checks.github.config.GitHubSCMSourceChecksTrait
- isVerboseConsoleLog() - Method in class io.jenkins.plugins.checks.github.config.GitSCMChecksExtension
O
- onEvent(GHSubscriberEvent) - Method in class io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber
P
- publish(ChecksDetails) - Method in class io.jenkins.plugins.checks.github.GitHubChecksPublisher
-
Publishes a GitHub check run.
S
- SCMFacade - Class in io.jenkins.plugins.checks.github
-
Facade to
GitHubSCMSource
andGitSCM
in Jenkins. - SCMFacade() - Constructor for class io.jenkins.plugins.checks.github.SCMFacade
- setName(String) - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
-
Set the name of the status checks.
- setName(String) - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
-
Set the name of the status checks.
- setSkip(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
-
Set if skip publishing status checks.
- setSkip(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
-
Set if skip publishing status checks.
- setSkipNotifications(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- setSkipProgressUpdates(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- setSkipProgressUpdates(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
- setSuppressLogs(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- setSuppressLogs(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
- setUnstableBuildNeutral(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitHubSCMSourceStatusChecksTrait
- setUnstableBuildNeutral(boolean) - Method in class io.jenkins.plugins.checks.github.status.GitSCMStatusChecksExtension
- setVerboseConsoleLog(boolean) - Method in class io.jenkins.plugins.checks.github.config.GitHubSCMSourceChecksTrait
- setVerboseConsoleLog(boolean) - Method in class io.jenkins.plugins.checks.github.config.GitSCMChecksExtension
All Classes and Interfaces|All Packages