Class BranchDiscoveryTrait

java.lang.Object
hudson.model.AbstractDescribableImpl<T>
jenkins.scm.api.trait.SCMTrait<jenkins.scm.api.trait.SCMSourceTrait>
jenkins.scm.api.trait.SCMSourceTrait
org.jenkinsci.plugins.github_branch_source.BranchDiscoveryTrait
All Implemented Interfaces:
ExtensionPoint, Describable<jenkins.scm.api.trait.SCMSourceTrait>

public class BranchDiscoveryTrait extends jenkins.scm.api.trait.SCMSourceTrait
A Discovery trait for GitHub that will discover branches on the repository.
Since:
2.2.0
  • Field Details

    • NONE

      public static final int NONE
      None strategy.
      See Also:
    • EXCLUDE_PRS

      public static final int EXCLUDE_PRS
      Exclude branches that are also filed as PRs.
      See Also:
    • ONLY_PRS

      public static final int ONLY_PRS
      Only branches that are also filed as PRs.
      See Also:
    • ALL_BRANCHES

      public static final int ALL_BRANCHES
      All branches.
      See Also:
  • Constructor Details

    • BranchDiscoveryTrait

      @DataBoundConstructor public BranchDiscoveryTrait(int strategyId)
      Constructor for stapler.
      Parameters:
      strategyId - the strategy id.
    • BranchDiscoveryTrait

      public BranchDiscoveryTrait(boolean buildBranch, boolean buildBranchWithPr)
      Constructor for legacy code.
      Parameters:
      buildBranch - build branches that are not filed as a PR.
      buildBranchWithPr - build branches that are also PRs.
  • Method Details

    • getStrategyId

      public int getStrategyId()
      Returns the strategy id.
      Returns:
      the strategy id.
    • isBuildBranch

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public boolean isBuildBranch()
      Returns true if building branches that are not filed as a PR.
      Returns:
      true if building branches that are not filed as a PR.
    • isBuildBranchesWithPR

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public boolean isBuildBranchesWithPR()
      Returns true if building branches that are filed as a PR.
      Returns:
      true if building branches that are filed as a PR.
    • decorateContext

      protected void decorateContext(jenkins.scm.api.trait.SCMSourceContext<?,?> context)
      Overrides:
      decorateContext in class jenkins.scm.api.trait.SCMSourceTrait
    • includeCategory

      public boolean includeCategory(@NonNull jenkins.scm.api.SCMHeadCategory category)
      Overrides:
      includeCategory in class jenkins.scm.api.trait.SCMSourceTrait