git

package

v0.7.0 Latest Latest Go to latest Published: Oct 20, 2020 License: MIT Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ubclaunchpad/inertia

Links

Open Source Insights

Documentation ¶

Overview ¶

Package git provides functions for interacting with git repositories

Index ¶

Variables
func AuthFailedErr(path ...string) error
func InitializeRepository(remoteURL string, opts RepoOptions, w io.Writer) (*gogit.Repository, error)
func SimplifyGitErr(err error) error
func UpdateRepository(repo *gogit.Repository, opts RepoOptions, out io.Writer) error
type RepoOptions

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 ¶ added in v0.5.0

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

RepoOptions declares options for a project repository

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL