Extension Points defined in GitHub Plugin

Table of Contents

ConditionalResult
GHEventsSubscriber
GitHubCommitShaSource
GitHubReposSource
GitHubRepositoryNameContributor
GitHubStatusBackrefSource
GitHubStatusContextSource
GitHubStatusResultSource
GitHubWebHook.Listener
StatusErrorHandler

ConditionalResult

org.jenkinsci.plugins.github.extension.status.misc.ConditionalResult in github

This extension point allows to define when and what to send as state and message. It will be used as part of org.jenkinsci.plugins.github.status.sources.ConditionalStatusResultSource .

Implementations:

GitHub Plugin: org.jenkinsci.plugins.github.status.sources.misc.AnyBuildResult (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.status.sources.misc.BetterThanOrEqualBuildResult (view on GitHub)

GHEventsSubscriber

org.jenkinsci.plugins.github.extension.GHEventsSubscriber in github

Extension point to subscribe events from GH, which plugin interested in. This point should return true in #isApplicable only if it can parse hooks with events contributed in #events()

Implementations:

GitHub Checks Plugin: io.jenkins.plugins.checks.github.CheckRunGHEventSubscriber (view on GitHub)
GitHub Integration Plugin: com.github.kostyasha.github.integration.branch.webhook.AbstractGHBranchSubscriber (view on GitHub)
GitHub Integration Plugin: org.jenkinsci.plugins.github.pullrequest.webhook.AbstractGHPullRequestSubsriber (view on GitHub)
GitHub Integration Plugin: com.github.kostyasha.github.integration.branch.webhook.GHBranchSubscriber (view on GitHub)
GitHub Integration Plugin: com.github.kostyasha.github.integration.multibranch.hooks.GHMultiBranchSubscriber (view on GitHub)
GitHub Integration Plugin: com.github.kostyasha.github.integration.multibranch.hooks.GHPRMultiBranchSubscriber (view on GitHub)
GitHub Integration Plugin: org.jenkinsci.plugins.github.pullrequest.webhook.GHPullRequestSubscriber (view on GitHub)
Github label filter Plugin: org.jenkinsci.plugins.github.label.filter.PullRequestGHEventSubscriber (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.webhook.subscriber.DefaultPushGHEventSubscriber (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.webhook.subscriber.PingGHEventSubscriber (view on GitHub)
GitHub PR Comment Build Plugin: com.adobe.jenkins.github_pr_comment_build.IssueCommentGHEventSubscriber (view on GitHub)
GitHub PR Comment Build Plugin: com.adobe.jenkins.github_pr_comment_build.IssueLabelGHEventSubscriber (view on GitHub)
GitHub PR Comment Build Plugin: com.adobe.jenkins.github_pr_comment_build.PRReviewGHEventSubscriber (view on GitHub)
GitHub PR Comment Build Plugin: com.adobe.jenkins.github_pr_comment_build.PRUpdateGHEventSubscriber (view on GitHub)
Pipeline: GitHub Plugin: org.jenkinsci.plugins.pipeline.github.trigger.GitHubEventSubscriber (view on GitHub)

GitHubCommitShaSource

org.jenkinsci.plugins.github.extension.status.GitHubCommitShaSource in github

Extension point to provide commit sha which will be used to set state

Implementations:

GitHub Plugin: org.jenkinsci.plugins.github.status.sources.BuildDataRevisionShaSource (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.status.sources.ManuallyEnteredShaSource (view on GitHub)

GitHubReposSource

org.jenkinsci.plugins.github.extension.status.GitHubReposSource in github

Extension point to provide list of resolved repositories where commit is located

Implementations:

GitHub Plugin: org.jenkinsci.plugins.github.status.sources.AnyDefinedRepositorySource (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.status.sources.ManuallyEnteredRepositorySource (view on GitHub)

GitHubRepositoryNameContributor

com.cloudbees.jenkins.GitHubRepositoryNameContributor in github

Extension point that associates GitHubRepositoryName s to a project.

Implementations:

GitHub Integration Plugin: com.github.kostyasha.github.integration.branch.webhook.GitHubBranchRepositoryNameContributor (view on GitHub)
GitHub Integration Plugin: org.jenkinsci.plugins.github.pullrequest.webhook.GitHubPRRepositoryNameContributor (view on GitHub)
GitHub Integration Plugin: com.github.kostyasha.github.integration.multibranch.hooks.GitHubScmSourceRepositoryNameContributor (view on GitHub)
GitHub Plugin: com.cloudbees.jenkins.GitHubRepositoryNameContributor.FromSCM (view on GitHub)
GitHub Plugin: com.cloudbees.jenkins.GitHubTrigger.GitHubRepositoryNameContributorImpl (view on GitHub)

GitHubStatusBackrefSource

org.jenkinsci.plugins.github.extension.status.GitHubStatusBackrefSource in github

Extension point to provide backref for the status, i.e. to the build or to the test report.

Implementations:

GitHub Plugin: org.jenkinsci.plugins.github.status.sources.BuildRefBackrefSource (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.status.sources.ManuallyEnteredBackrefSource (view on GitHub)

GitHubStatusContextSource

org.jenkinsci.plugins.github.extension.status.GitHubStatusContextSource in github

Extension point to provide context of the state. For example `integration-tests` or `build`

Implementations:

GitHub Plugin: org.jenkinsci.plugins.github.status.sources.DefaultCommitContextSource (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.status.sources.ManuallyEnteredCommitContextSource (view on GitHub)

GitHubStatusResultSource

org.jenkinsci.plugins.github.extension.status.GitHubStatusResultSource in github

Extension point to provide exact state and message for the commit

Implementations:

GitHub Plugin: org.jenkinsci.plugins.github.status.sources.ConditionalStatusResultSource (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.status.sources.DefaultStatusResultSource (view on GitHub)

GitHubWebHook.Listener

com.cloudbees.jenkins.GitHubWebHook.Listener in github

Other plugins may be interested in listening for these updates.

Implementations:

(no known implementations)

StatusErrorHandler

org.jenkinsci.plugins.github.extension.status.StatusErrorHandler in github

Extension point to provide way of how to react on errors in status setter step

Implementations:

GitHub Plugin: org.jenkinsci.plugins.github.status.err.ChangingBuildStatusErrorHandler (view on GitHub)
GitHub Plugin: org.jenkinsci.plugins.github.status.err.ShallowAnyErrorHandler (view on GitHub)

Developer Documentation

Plugin Tutorial

How-To Guides

Reference Topics

Resources

Extensions Index

Javadoc

Taglibs

Tools

Extension Points defined in GitHub Plugin

ConditionalResult

GHEventsSubscriber

GitHubCommitShaSource

GitHubReposSource

GitHubRepositoryNameContributor

GitHubStatusBackrefSource

GitHubStatusContextSource

GitHubStatusResultSource

GitHubWebHook.Listener

StatusErrorHandler