Package org.kohsuke.github

Class GHBranch

java.lang.Object
org.kohsuke.github.GHBranch
public class GHBranch extends Object
A branch in a repository.
Author:
Yusuke Kokubo

  • Method Details

    • getOwner

      public GHRepository getOwner()
      Gets owner.
      Returns:
      the repository that this branch is in.

    • getName

      public String getName()
      Gets name.
      Returns:
      the name

    • isProtected

      @Preview(LUKE_CAGE) public boolean isProtected()
      Is protected boolean.
      Returns:
      true if the push to this branch is restricted via branch protection.

    • getProtectionUrl

      @Preview(LUKE_CAGE) public URL getProtectionUrl()
      Gets protection url.
      Returns:
      API URL that deals with the protection of this branch.

    • getProtection

      @Preview(LUKE_CAGE) public GHBranchProtection getProtection() throws IOException
      Gets protection.
      Returns:
      the protection
      Throws:
      IOException - the io exception

    • getSHA1

      public String getSHA1()
      Gets sha 1.
      Returns:
      The SHA1 of the commit that this branch currently points to.

    • disableProtection

      public void disableProtection() throws IOException
      Disables branch protection and allows anyone with push access to push changes.
      Throws:
      IOException - if disabling protection fails

    • enableProtection

      @Preview(LUKE_CAGE) public GHBranchProtectionBuilder enableProtection()
      Enables branch protection to control what commit statuses are required to push.
      Returns:
      GHBranchProtectionBuilder for enabling protection
      See Also:

    • enableProtection

      @Deprecated public void enableProtection(EnforcementLevel level, Collection<String> contexts) throws IOException
      Deprecated.
      Enable protection.
      Parameters:
      level - the level
      contexts - the contexts
      Throws:
      IOException - the io exception

    • merge

      @CheckForNull public GHCommit merge(GHBranch headBranch, String commitMessage) throws IOException
      Merge a branch into this branch.
      Parameters:
      headBranch - the branch whose head will be merged
      commitMessage - the commit message
      Returns:
      the merge GHCommit created, or null if the base already contains the head (nothing to merge).
      Throws:
      IOException - if merging fails

    • merge

      @CheckForNull public GHCommit merge(String head, String commitMessage) throws IOException
      Merge a ref into this branch.
      Parameters:
      head - the ref name that will be merged into this branch. Follows the usual ref naming rules, could be a branch name, tag, or commit sha.
      commitMessage - the commit message
      Returns:
      the merge GHCommit created, or null if the base already contains the head (nothing to merge).
      Throws:
      IOException - if merging fails

    • toString

      public String toString()
      To string.
      Overrides:
      toString in class Object
      Returns:
      the string

    • getRoot

      @Deprecated public GitHub getRoot()
      Deprecated.
      For access to the GitHub instance, use a local copy instead of pulling it out of objects.
      Get the root GitHub instance for this object.
      Returns:
      the root GitHub instance