Documentation

Overview

    Package git provides functions for interacting with git repositories

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	// ErrInvalidGitAuthentication is returned when handshake with a git remote fails
    	ErrInvalidGitAuthentication = errors.New("git authentication failed")
    )

    Functions

    func AuthFailedErr

    func AuthFailedErr(path ...string) error

      AuthFailedErr attaches the daemon key in the error message

      func InitializeRepository

      func InitializeRepository(remoteURL string, opts RepoOptions, w io.Writer) (*gogit.Repository, error)

        InitializeRepository sets up a project repository for the first time

        func SimplifyGitErr

        func SimplifyGitErr(err error) error

          SimplifyGitErr checks errors that involve git remote operations and simplifies them to ErrInvalidGitAuthentication if possible

          func UpdateRepository

          func UpdateRepository(repo *gogit.Repository, opts RepoOptions, out io.Writer) error

            UpdateRepository pulls and checkouts given branch from repository

            Types

            type RepoOptions

            type RepoOptions struct {
            	Directory string
            	Branch    string
            	Auth      transport.AuthMethod
            }

              RepoOptions declares options for a project repository