gitutil

Documentation

Index

• Variables
• func CloneRepo(repoURL string) (string, error)
• func RemoteToGithubURL(remote string) (string, error)
• func SplitGithubURL(githubURL string) (account, repo string, ok bool)
• type Remote
  • func ExtractGitRemote(projectPath, remoteName string, detectDotGit bool) (*Remote, string, error)
  • func ExtractRemotes(projectPath string, detectDotGit bool) ([]Remote, error)
  • func RemotesToGithubURL(remotes []Remote) (*Remote, string, error)
• type SyncStatus
  • func GetSyncStatus(repoPath, branch, remote string) (SyncStatus, error)

Variables

var ErrGitRemoteNotFound = errors.New("no git remotes found")

Functions

func CloneRepo

func CloneRepo(repoURL string) (string, error)

func RemoteToGithubURL

func RemoteToGithubURL(remote string) (string, error)

func SplitGithubURL

func SplitGithubURL(githubURL string) (account, repo string, ok bool)

Types

type Remote

type Remote struct {
	Name string
	URL  string
}

func ExtractGitRemote

func ExtractGitRemote(projectPath, remoteName string, detectDotGit bool) (*Remote, string, error)

func ExtractRemotes

func ExtractRemotes(projectPath string, detectDotGit bool) ([]Remote, error)

func RemotesToGithubURL

func RemotesToGithubURL(remotes []Remote) (*Remote, string, error)

type SyncStatus

type SyncStatus int

const (
	SyncStatusUnspecified SyncStatus = iota
	SyncStatusModified               // Local branch has untracked/modified changes
	SyncStatusAhead                  // Local branch is ahead of remote branch
	SyncStatusSynced                 // Local branch is in sync with remote branch
)

func GetSyncStatus

func GetSyncStatus(repoPath, branch, remote string) (SyncStatus, error)

GetSyncStatus returns the status of current branch as compared to remote/branch TODO: Need to implement cases like local branch is behind/diverged from remote branch