Extension Points defined in Branch API Plugin

Table of Contents

BranchBuildStrategy
BranchProjectFactory
BranchProperty
BranchPropertyStrategy
MultiBranchProjectFactory

BranchBuildStrategy

jenkins.branch.BranchBuildStrategy in branch-api

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

Methods marked as {@code SPI:} are intended to be implemented by implementers of BranchBuildStrategy . Methods marked as {@code API:} are intended to be invoked consumers of BranchBuildStrategy . A consumer invoking a {@code SPI:} method may get a UnsupportedOperationException . </p>

Implementations:

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.TagBuildStrategyImpl (view on GitHub)
Ignore Committer Strategy Plugin: au.com.versent.jenkins.plugins.ignoreCommitterStrategy.IgnoreCommitterStrategy (view on GitHub)

BranchProjectFactory

jenkins.branch.BranchProjectFactory in branch-api

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

Implementations:

Literate Plugin: org.cloudbees.literate.jenkins.LiterateMultibranchProject.ProjectFactoryImpl (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)
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)
YAML Project support Plugin: com.google.jenkins.plugins.dsl.YamlProjectFactory

BranchProperty

jenkins.branch.BranchProperty in branch-api

Additional information associated with Branch .

jenkins.scm.api.SCMSource s can use properties to convey additional implementation/SCM specific information that's not captured in the base 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.TriggerPRUpdateBranchProperty (view on GitHub)
Literate Plugin: org.cloudbees.literate.jenkins.LiterateBranchProperty (view on GitHub)
Literate Plugin: org.cloudbees.literate.jenkins.ParametersDefinitionBranchProperty (view on GitHub)
Literate Plugin: org.cloudbees.literate.jenkins.promotions.PromotionBranchProperty (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.DurabilityHintBranchProperty (view on GitHub)

BranchPropertyStrategy

jenkins.branch.BranchPropertyStrategy in branch-api

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

Implementations:

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

MultiBranchProjectFactory

jenkins.branch.MultiBranchProjectFactory in branch-api

Creates MultiBranchProject s for repositories where recognized.

Implementations:

Branch API Plugin: jenkins.branch.MultiBranchProjectFactory.BySCMSourceCriteria (view on GitHub)
Literate Plugin: org.cloudbees.literate.jenkins.LiterateMultibranchProjectFactory (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)

Extension Points defined in Branch API Plugin

BranchBuildStrategy

BranchProjectFactory

BranchProperty

BranchPropertyStrategy

MultiBranchProjectFactory

Resources

Solutions

Project

Community