Extension Points defined in Branch 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.

Branch API Plugin

BranchBuildStrategy

jenkinsdoc:branch-api:jenkins.branch.BranchBuildStrategy]

An extension point that allows controlling whether a specific jenkinsdoc:SCMHead] should be automatically built when discovered.

Methods marked as {@code SPI:} are intended to be implemented by implementers of jenkinsdoc:BranchBuildStrategy] . Methods marked as {@code API:} are intended to be invoked consumers of jenkinsdoc:BranchBuildStrategy] . A consumer invoking a {@code SPI:} method may get a jenkinsdoc:UnsupportedOperationException] . Methods marked as {@code SPI:} are only to be invoked through the API methods in order to allow safe evolution. Changing the API may require updating any SPI implementations that are also API consumers, specifically the Any, All and None implementations in basic-branch-build-strategies</p>

Implementations:

Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.AllBranchBuildStrategyImpl (view on GitHub)
Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.AnyBranchBuildStrategyImpl (view on GitHub)
Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.BranchBuildStrategyImpl (view on GitHub)
Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.ChangeRequestBuildStrategyImpl (view on GitHub)
Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.NamedBranchBuildStrategyImpl (view on GitHub)
Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.NoneBranchBuildStrategyImpl (view on GitHub)
Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.SkipInitialBuildOnFirstBranchIndexing (view on GitHub)
Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.TagBuildStrategyImpl (view on GitHub)
GitHub Integration Plugin: com.github.kostyasha.github.integration.multibranch.GitHubBranchBuildStrategy (view on GitHub)
Ignore Committer Strategy Plugin: au.com.versent.jenkins.plugins.ignoreCommitterStrategy.IgnoreCommitterStrategy (view on GitHub)
Pipeline: Multibranch build strategy extension Plugin: com.igalg.jenkins.plugins.multibranch.buildstrategy.BranchBuildStrategyExtension (view on GitHub)
Pipeline: Multibranch build strategy extension Plugin: com.igalg.jenkins.plugins.multibranch.buildstrategy.ExcludeByIgnoreFileBranchBuildStrategy (view on GitHub)
Pipeline: Multibranch build strategy extension Plugin: com.igalg.jenkins.plugins.multibranch.buildstrategy.ExcludeRegionBranchBuildStrategy (view on GitHub)
Pipeline: Multibranch build strategy extension Plugin: com.igalg.jenkins.plugins.multibranch.buildstrategy.IncludeRegionBranchBuildStrategy (view on GitHub)

BranchProjectFactory

jenkinsdoc:branch-api:jenkins.branch.BranchProjectFactory]

Creates instances of the branch projects for a specific jenkinsdoc:Branch] and also provides some utility methods for updating the branch specific projects.

Implementations:

Config-Driven Pipeline Plugin: org.jenkinsci.plugins.workflow.multibranch.template.ConfigDrivenWorkflowBranchProjectFactory (view on GitHub)
Multi-Branch Project Plugin (DEPRECATED) Plugin: com.github.mjdetullio.jenkins.plugins.multibranch.FreeStyleBranchProjectFactory (view on GitHub)
Multi-Branch Project Plugin (DEPRECATED) Plugin: com.github.mjdetullio.jenkins.plugins.multibranch.IvyBranchProjectFactory (view on GitHub)
Multi-Branch Project Plugin (DEPRECATED) Plugin: com.github.mjdetullio.jenkins.plugins.multibranch.MatrixBranchProjectFactory (view on GitHub)
Multi-Branch Project Plugin (DEPRECATED) Plugin: com.github.mjdetullio.jenkins.plugins.multibranch.MavenBranchProjectFactory (view on GitHub)
Multi-Branch Project Plugin (DEPRECATED) Plugin: com.github.mjdetullio.jenkins.plugins.multibranch.TemplateDrivenBranchProjectFactory (view on GitHub)
MultiBranch Action Triggers Plugin: org.jenkinsci.plugins.workflow.multibranch.ExtendedWorkflowMultiBranchProject (view on GitHub)
Multibranch Pipeline Inline Definition Plugin: org.jenkinsci.plugins.inlinepipeline.InlineDefinitionBranchProjectFactory (view on GitHub)
OES Template Plugin: cn.opsbox.jenkinsci.plugins.cps.OesTemplateWorkflowBranchProjectFactory (view on GitHub)
Pipeline As YAML (Incubated) Plugin: io.jenkins.plugins.pipeline.PipelineAsYamlWorkflowBranchProjectFactory (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.WorkflowBranchProjectFactory (view on GitHub)
Pipeline: Multibranch with defaults Plugin: org.jenkinsci.plugins.pipeline.multibranch.defaults.PipelineBranchDefaultsProjectFactory (view on GitHub)
Remote Jenkinsfile Provider Plugin: org.jenkinsci.plugins.workflow.multibranch.extended.RemoteJenkinsFileWorkflowBranchProjectFactory (view on GitHub)

BranchProperty

jenkinsdoc:branch-api:jenkins.branch.BranchProperty]

Additional information associated with jenkinsdoc:Branch] .

jenkinsdoc:jenkins.scm.api.SCMSource] s can use properties to convey additional implementation/SCM specific information that's not captured in the base jenkinsdoc:Branch] class.</p>

Implementations:

Backlog Plugin: hudson.plugins.backlog.pipeline.BacklogPullRequestBranchProperty (view on GitHub)
Branch API Plugin: jenkins.branch.BuildRetentionBranchProperty (view on GitHub)
Branch API Plugin: jenkins.branch.NoTriggerBranchProperty (view on GitHub)
Branch API Plugin: jenkins.branch.ParameterDefinitionBranchProperty (view on GitHub)
Branch API Plugin: jenkins.branch.RateLimitBranchProperty (view on GitHub)
Branch API Plugin: jenkins.branch.UntrustedBranchProperty (view on GitHub)
GitHub PR Comment Build Plugin: com.adobe.jenkins.github_pr_comment_build.TriggerPRCommentBranchProperty (view on GitHub)
GitHub PR Comment Build Plugin: com.adobe.jenkins.github_pr_comment_build.TriggerPRReviewBranchProperty (view on GitHub)
GitHub PR Comment Build Plugin: com.adobe.jenkins.github_pr_comment_build.TriggerPRUpdateBranchProperty (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.DurabilityHintBranchProperty (view on GitHub)

BranchPropertyStrategy

jenkinsdoc:branch-api:jenkins.branch.BranchPropertyStrategy]

A strategy for determining the properties that apply to a specific jenkinsdoc:SCMHead] .

Implementations:

Branch API Plugin: jenkins.branch.DefaultBranchPropertyStrategy (view on GitHub)
Branch API Plugin: jenkins.branch.NamedExceptionsBranchPropertyStrategy (view on GitHub)

MultiBranchProjectFactory

jenkinsdoc:branch-api:jenkins.branch.MultiBranchProjectFactory]

Creates jenkinsdoc:MultiBranchProject] s for repositories where recognized.

Implementations:

Branch API Plugin: jenkins.branch.MultiBranchProjectFactory.BySCMSourceCriteria (view on GitHub)
Config-Driven Pipeline Plugin: org.jenkinsci.plugins.workflow.multibranch.template.ConfigDrivenWorkflowMultiBranchProjectFactory (view on GitHub)
Multibranch Pipeline Inline Definition Plugin: org.jenkinsci.plugins.inlinepipeline.InlineDefinitionMultiBranchProjectFactory (view on GitHub)
OES Template Plugin: cn.opsbox.jenkinsci.plugins.cps.OesTemplateWorkflowMultiBranchProjectFactory (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowMultiBranchProjectFactory (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProjectFactory (view on GitHub)
Pipeline: Multibranch with defaults Plugin: org.jenkinsci.plugins.pipeline.multibranch.defaults.PipelineMultiBranchDefaultsProjectFactory (view on GitHub)
Remote Jenkinsfile Provider Plugin: org.jenkinsci.plugins.workflow.multibranch.extended.RemoteJenkinsFileWorkflowMultiBranchProjectFactory (view on GitHub)

PropertyMigration

jenkinsdoc:branch-api:jenkins.branch.PropertyMigration]

An extension point that captures the need for a complex migration of a folder property into some other configuration of the containing folder.

Implementations:

Branch API Plugin: jenkins.branch.NoTriggerOrganizationFolderProperty.PropertyMigrationImpl (view on GitHub)

PropertyMigration.Migrator

jenkinsdoc:branch-api:jenkins.branch.PropertyMigration.Migrator]

This extension point has no Javadoc documentation.

Implementations:

Basic Branch Build Strategies Plugin: jenkins.branch.buildstrategies.basic.NoTriggerOrganizationFolderMigration (view on GitHub)