Package com.xenoterracide.gradle.git

Interface GitRemote

All Known Implementing Classes:
GitRemoteForGradle
public interface GitRemote
Git Remote information.

  • Method Summary

    Modifier and Type
    Method
    Description
    default @Nullable String
    headBranch()
    Gets the remote HEAD branch.
    @Nullable String
    headBranchRefName()
    Gets the remote HEAD branch ref name.
    String
    name()
    Gets the remote name; a common example is origin.

  • Method Details

    • headBranch

      default @Nullable String headBranch()
      Gets the remote HEAD branch. This removes the refs/heads/ prefix.
      Returns:
      HEAD branch

    • headBranchRefName

      @Nullable String headBranchRefName()
      Gets the remote HEAD branch ref name. This will look something like refs/remotes/origin/main.
      Returns:
      HEAD branch ref name

    • name

      String name()
      Gets the remote name; a common example is origin.
      Returns:
      remote name