Extension Points defined in SCM API Plugin

This site is the new docs site currently being tested. For the actual docs in use please go to https://www.jenkins.io/doc.

SCM API Plugin

SCMEventListener

jenkinsdoc:scm-api:jenkins.scm.api.SCMEventListener]

Base class for listeners to jenkinsdoc:SCMEvent] s

Implementations:

Branch API Plugin: jenkins.branch.MultiBranchProject.SCMEventListenerImpl (view on GitHub)
Branch API Plugin: jenkins.branch.OrganizationFolder.SCMEventListenerImpl (view on GitHub)
SCM API Plugin: jenkins.scm.impl.SCMTriggerListener (view on GitHub)

SCMFileSystem.Builder

jenkinsdoc:scm-api:jenkins.scm.api.SCMFileSystem.Builder]

Extension point that allows different plugins to implement jenkinsdoc:SCMFileSystem] classes for the same jenkinsdoc:SCM] or jenkinsdoc:SCMSource] and let Jenkins pick the most capable for any specific jenkinsdoc:SCM] implementation.

Implementations:

Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.filesystem.BitbucketSCMFileSystem.BuilderImpl (view on GitHub)
Bitbucket Server Integration Plugin: com.atlassian.bitbucket.jenkins.internal.scm.filesystem.BitbucketSCMFileSystem.BuilderImpl (view on GitHub)
Git Plugin: jenkins.plugins.git.GitSCMFileSystem.BuilderImpl (view on GitHub)
Git Plugin: jenkins.plugins.git.GitSCMTelescope (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.GitHubSCMFileSystem.BuilderImpl (view on GitHub)
GitHub Integration Plugin: com.github.kostyasha.github.integration.multibranch.fs.GitHubSCMFileSystemBuilder (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.GitLabSCMFileSystem.BuilderImpl (view on GitHub)
MergeBot PlasticSCM Plugin: com.codicesoftware.plasticscm.plugins.mergebot.jenkins.PlasticSCMFileSystem.BuilderImpl (view on GitHub)
PlasticSCM Plugin: com.codicesoftware.plugins.jenkins.PlasticSCMFileSystem.BuilderImpl (view on GitHub)
Subversion Plugin: jenkins.scm.impl.subversion.SubversionSCMFileSystem.BuilderImpl (view on GitHub)
Tuleap Git Branch Source Plugin: org.jenkinsci.plugins.tuleap_git_branch_source.config.TuleapSCMFileSystem.BuilderImpl (view on GitHub)

SCMHead.HeadByItem

jenkinsdoc:scm-api:jenkins.scm.api.SCMHead.HeadByItem]

Means of locating a head given an item.

Implementations:

Branch API Plugin: jenkins.branch.BranchProjectFactory.HeadByItemImpl (view on GitHub)

SCMHeadMigration

jenkinsdoc:scm-api:jenkins.scm.api.SCMHeadMigration]

If a jenkinsdoc:SCMSource] plugin needs to migrate the implementation classes for jenkinsdoc:SCMHead] this extension point allows the plugin to register type migrations. For speed of migration implementations should just jump directly to the final end-point and not expect recursive chain walking.

Implementations:

Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.PullRequestSCMHead.FixLegacyMigration1 (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.SCMHeadWithOwnerAndRepo.GitMigrationImpl (view on GitHub)
Git Plugin: jenkins.plugins.git.GitBranchSCMHead.SCMHeadMigrationImpl (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.BranchSCMHead.MigrationImpl (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.PullRequestSCMHead.FixMetadataMigration (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.PullRequestSCMHead.FixOriginMigration (view on GitHub)

SCMNavigator

jenkinsdoc:scm-api:jenkins.scm.api.SCMNavigator]

An API for discovering new and navigating already discovered jenkinsdoc:SCMSource] s within an organization. An implementation does not need to cache existing discoveries, but some form of caching is strongly recommended where the backing provider of repositories has a rate limiter on API calls.

Implementations:

AWS Code Commit Jobs Plugin: com.jenkins.plugins.awscodecommit.navigator.AWSCodeCommitSCMNavigator (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMNavigator (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.GitHubSCMNavigator (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.GitLabSCMNavigator (view on GitHub)
SCM API Plugin: jenkins.scm.impl.SingleSCMNavigator (view on GitHub)
SCM-Manager Plugin: com.cloudogu.scmmanager.scm.ScmManagerNavigator (view on GitHub)
Tuleap Git Branch Source Plugin: org.jenkinsci.plugins.tuleap_git_branch_source.TuleapSCMNavigator (view on GitHub)

SCMNavigatorOwners

jenkinsdoc:scm-api:jenkins.scm.api.SCMNavigatorOwners]

Provides a means to lookup the jenkinsdoc:SCMNavigatorOwners] that own jenkinsdoc:SCMNavigatorOwner] instances.

Implementations:

(no known implementations)

SCMNavigatorOwners.Enumerator

jenkinsdoc:scm-api:jenkins.scm.api.SCMNavigatorOwners.Enumerator]

Extension point to allow for access to embedded jenkinsdoc:SCMSourceOwner] instances that jenkinsdoc:SCMNavigatorOwners.JenkinsItemEnumerator] will not find.

Implementations:

SCM API Plugin: jenkins.scm.api.SCMNavigatorOwners.JenkinsItemEnumerator (view on GitHub)

SCMSource

jenkinsdoc:scm-api:jenkins.scm.api.SCMSource]

A jenkinsdoc:SCMSource] is responsible for fetching jenkinsdoc:SCMHead] and corresponding jenkinsdoc:SCMRevision] instances from which it can build jenkinsdoc:SCM] instances that are configured to check out the specific jenkinsdoc:SCMHead] at the specified jenkinsdoc:SCMRevision] .

Implementations:

Backlog Plugin: hudson.plugins.backlog.pipeline.BacklogPullRequestSCMSource (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource (view on GitHub)
Bitbucket Server Integration Plugin: com.atlassian.bitbucket.jenkins.internal.scm.BitbucketSCMSource (view on GitHub)
Bitbucket Server Integration Plugin: com.atlassian.bitbucket.jenkins.internal.scm.CustomGitSCMSource (view on GitHub)
DAGsHub Branch Source Plugin: io.jenkins.plugins.dagshubbranchsource.DAGsHubSCMSource (view on GitHub)
Gerrit Code Review Plugin: jenkins.plugins.gerrit.AbstractGerritSCMSource (view on GitHub)
Gerrit Code Review Plugin: jenkins.plugins.gerrit.GerritSCMSource (view on GitHub)
Git Pipeline for Blue Ocean Plugin: Anonymous class in io.jenkins.blueocean.blueocean_git_pipeline.GitReadSaveService (view on GitHub)
Git Plugin: jenkins.plugins.git.AbstractGitSCMSource (view on GitHub)
Git Plugin: jenkins.plugins.git.GitSCMSource (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.GitHubSCMSource (view on GitHub)
GitHub Integration Plugin: com.github.kostyasha.github.integration.multibranch.GitHubSCMSource (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.GitLabSCMSource (view on GitHub)
Mercurial Plugin: hudson.plugins.mercurial.MercurialSCMSource (view on GitHub)
SCM API Plugin: jenkins.scm.impl.NullSCMSource (view on GitHub)
SCM API Plugin: jenkins.scm.impl.SingleSCMSource (view on GitHub)
SCM-Manager Plugin: com.cloudogu.scmmanager.scm.ScmManagerSource (view on GitHub)
SCM-Manager Plugin: com.cloudogu.scmmanager.scm.ScmManagerSvnSource (view on GitHub)
Subversion Plugin: jenkins.scm.impl.subversion.SubversionSCMSource (view on GitHub)
Tuleap Git Branch Source Plugin: org.jenkinsci.plugins.tuleap_git_branch_source.TuleapSCMSource (view on GitHub)

SCMSource.SourceByItem

jenkinsdoc:scm-api:jenkins.scm.api.SCMSource.SourceByItem]

Means of locating a head given an item.

Implementations:

Branch API Plugin: jenkins.branch.BranchProjectFactory.SourceByItemImpl (view on GitHub)

SCMSourceOwners

jenkinsdoc:scm-api:jenkins.scm.api.SCMSourceOwners]

Provides a means to lookup the jenkinsdoc:SCMSourceOwners] that own jenkinsdoc:SCMSource] instances.

Implementations:

(no known implementations)

SCMSourceOwners.Enumerator

jenkinsdoc:scm-api:jenkins.scm.api.SCMSourceOwners.Enumerator]

Extension point to allow for access to embedded jenkinsdoc:SCMSourceOwner] instances that jenkinsdoc:SCMSourceOwners.JenkinsItemEnumerator] will not find.

Implementations:

SCM API Plugin: jenkins.scm.api.SCMSourceOwners.JenkinsItemEnumerator (view on GitHub)

SCMTrait

jenkinsdoc:scm-api:jenkins.scm.api.trait.SCMTrait]

Base class for common traits.

Implementations:

Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.BitbucketBuildStatusNotificationsTrait (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.BranchDiscoveryTrait (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.OriginPullRequestDiscoveryTrait (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.PublicRepoPullRequestFilterTrait (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.SSHCheckoutTrait (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.TagDiscoveryTrait (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.WebhookConfigurationTrait (view on GitHub)
Bitbucket Branch Source Plugin: com.cloudbees.jenkins.plugins.bitbucket.WebhookRegistrationTrait (view on GitHub)
Bitbucket Pull Requests filter Plugin: org.jenkinsci.plugins.bitbucket.pullrequests.filter.traits.PullRequestNameFilterTrait (view on GitHub)
Bitbucket Pull Requests filter Plugin: org.jenkinsci.plugins.bitbucket.pullrequests.filter.traits.PullRequestSourceBranchFilterTrait (view on GitHub)
Bitbucket Pull Requests filter Plugin: org.jenkinsci.plugins.bitbucket.pullrequests.filter.traits.PullRequestTargetBranchFilterTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.AuthorInChangelogTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.BranchDiscoveryTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.CheckoutOptionTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.CleanAfterCheckoutTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.CleanBeforeCheckoutTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.CloneOptionTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.DiscoverOtherRefsTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.GitBrowserSCMSourceTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.GitLFSPullTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.GitSCMExtensionTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.GitToolSCMSourceTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.IgnoreOnPushNotificationTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.LocalBranchTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.PruneStaleBranchTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.PruneStaleTagTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.RefSpecsSCMSourceTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.RemoteNameSCMSourceTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.SparseCheckoutPathsTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.SubmoduleOptionTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.TagDiscoveryTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.UserIdentityTrait (view on GitHub)
Git Plugin: jenkins.plugins.git.traits.WipeWorkspaceTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.BranchDiscoveryTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.ExcludeArchivedRepositoriesTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.ExcludeForkedRepositoriesTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.ExcludePrivateRepositoriesTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.ExcludePublicRepositoriesTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.ForkPullRequestDiscoveryTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.IgnoreDraftPullRequestFilterTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.OriginPullRequestDiscoveryTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.TagDiscoveryTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.TeamSlugTrait (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.TopicsTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.BranchDiscoveryTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.BuildStatusNameCustomPartTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.ExcludeArchivedRepositoriesTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.ForkMergeRequestDiscoveryTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.GitLabAvatarTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.GitLabSkipNotificationsTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.HookRegistrationTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.LogCommentTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.OriginMergeRequestDiscoveryTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.ProjectNamingStrategyTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.SSHCheckoutTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.SubGroupProjectDiscoveryTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.TagDiscoveryTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.TriggerMRCommentTrait (view on GitHub)
GitLab Branch Source Plugin: io.jenkins.plugins.gitlabbranchsource.WebhookListenerBuildConditionsTrait (view on GitHub)
Mercurial Plugin: hudson.plugins.mercurial.traits.CleanMercurialSCMSourceTrait (view on GitHub)
Mercurial Plugin: hudson.plugins.mercurial.traits.MercurialBrowserSCMSourceTrait (view on GitHub)
Mercurial Plugin: hudson.plugins.mercurial.traits.MercurialInstallationSCMSourceTrait (view on GitHub)
SCM API Plugin: jenkins.scm.impl.trait.RegexSCMHeadFilterTrait (view on GitHub)
SCM API Plugin: jenkins.scm.impl.trait.RegexSCMSourceFilterTrait (view on GitHub)
SCM API Plugin: jenkins.scm.api.trait.SCMNavigatorTrait (view on GitHub)
SCM API Plugin: jenkins.scm.api.trait.SCMSourceTrait (view on GitHub)
SCM API Plugin: jenkins.scm.impl.trait.WildcardSCMHeadFilterTrait (view on GitHub)
SCM API Plugin: jenkins.scm.impl.trait.WildcardSCMSourceFilterTrait (view on GitHub)
Skip Notifications Trait Plugin: com.cloudbees.jenkins.plugins.bitbucket.notifications.BitbucketSkipNotifications (view on GitHub)
Skip Notifications Trait Plugin: org.jenkinsci.plugins.github.notifications.GithubSkipNotifications (view on GitHub)
Tuleap Git Branch Source Plugin: org.jenkinsci.plugins.tuleap_git_branch_source.trait.TuleapBranchDiscoveryTrait (view on GitHub)
Tuleap Git Branch Source Plugin: org.jenkinsci.plugins.tuleap_git_branch_source.trait.TuleapCommitNotificationTrait (view on GitHub)
Tuleap Git Branch Source Plugin: org.jenkinsci.plugins.tuleap_git_branch_source.trait.TuleapForkPullRequestDiscoveryTrait (view on GitHub)
Tuleap Git Branch Source Plugin: org.jenkinsci.plugins.tuleap_git_branch_source.trait.TuleapOriginPullRequestDiscoveryTrait (view on GitHub)