git

Documentation

Index

• func GetRepoHTTPClient(repoURL string, insecure bool, creds Creds) *http.Client
• func IsCommitSHA(sha string) bool
• func IsHTTPSURL(url string) bool
• func IsSSHURL(url string) (bool, string)
• func IsTruncatedCommitSHA(sha string) bool
• func NormalizeGitURL(repo string) string
• func SameURL(leftRepo, rightRepo string) bool
• func TestRepo(repo string, creds Creds, insecure bool, enableLfs bool) error
• type Client
  • func NewClient(rawRepoURL string, creds Creds, insecure bool, enableLfs bool) (Client, error)
  • func NewClientExt(rawRepoURL string, root string, creds Creds, insecure bool, enableLfs bool) (Client, error)
• type Creds
• type GenericHTTPSCreds
  • func NewGitHubAppCreds(appID int64, appInstallId int64, privateKey string, baseURL string, ...) GenericHTTPSCreds
  • func NewHTTPSCreds(username string, password string, clientCertData string, clientCertKey string, ...) GenericHTTPSCreds
• type GitHubAppCreds
  • func (g GitHubAppCreds) Environ() (io.Closer, []string, error)
  • func (g GitHubAppCreds) GetClientCertData() string
  • func (g GitHubAppCreds) GetClientCertKey() string
  • func (g GitHubAppCreds) HasClientCert() bool
• type HTTPSCreds
  • func (c HTTPSCreds) Environ() (io.Closer, []string, error)
  • func (c HTTPSCreds) GetClientCertData() string
  • func (c HTTPSCreds) GetClientCertKey() string
  • func (g HTTPSCreds) HasClientCert() bool
• type NopCloser
  • func (c NopCloser) Close() error
• type NopCreds
  • func (c NopCreds) Environ() (io.Closer, []string, error)
• type Refs
• type RevisionMetadata
• type SSHCreds
  • func NewSSHCreds(sshPrivateKey string, caPath string, insecureIgnoreHostKey bool) SSHCreds
  • func (c SSHCreds) Environ() (io.Closer, []string, error)

Functions

func GetRepoHTTPClient

func GetRepoHTTPClient(repoURL string, insecure bool, creds Creds) *http.Client

Returns a HTTP client object suitable for go-git to use using the following pattern:

• If insecure is true, always returns a client with certificate verification turned off.
• If one or more custom certificates are stored for the repository, returns a client with those certificates in the list of root CAs used to verify the server's certificate.
• Otherwise (and on non-fatal errors), a default HTTP client is returned.

func IsCommitSHA

func IsCommitSHA(sha string) bool

IsCommitSHA returns whether or not a string is a 40 character SHA-1

func IsHTTPSURL

func IsHTTPSURL(url string) bool

IsHTTPSURL returns true if supplied URL is HTTPS URL

func IsSSHURL

func IsSSHURL(url string) (bool, string)

IsSSHURL returns true if supplied URL is SSH URL

func IsTruncatedCommitSHA

func IsTruncatedCommitSHA(sha string) bool

IsTruncatedCommitSHA returns whether or not a string is a truncated SHA-1

func NormalizeGitURL

func NormalizeGitURL(repo string) string

NormalizeGitURL normalizes a git URL for purposes of comparison, as well as preventing redundant local clones (by normalizing various forms of a URL to a consistent location). Prefer using SameURL() over this function when possible. This algorithm may change over time and should not be considered stable from release to release

func SameURL

func SameURL(leftRepo, rightRepo string) bool

SameURL returns whether or not the two repository URLs are equivalent in location

func TestRepo

func TestRepo(repo string, creds Creds, insecure bool, enableLfs bool) error

TestRepo tests if a repo exists and is accessible with the given credentials

Types

type Client

type Client interface {
	Root() string
	Init() error
	Fetch(revision string) error
	Checkout(revision string) error
	LsRefs() (*Refs, error)
	LsRemote(revision string) (string, error)
	LsFiles(path string) ([]string, error)
	LsLargeFiles() ([]string, error)
	CommitSHA() (string, error)
	RevisionMetadata(revision string) (*RevisionMetadata, error)
	VerifyCommitSignature(string) (string, error)
}

Client is a generic git client interface

func NewClient

func NewClient(rawRepoURL string, creds Creds, insecure bool, enableLfs bool) (Client, error)

func NewClientExt

func NewClientExt(rawRepoURL string, root string, creds Creds, insecure bool, enableLfs bool) (Client, error)

type Creds

type Creds interface {
	Environ() (io.Closer, []string, error)
}

type GenericHTTPSCreds

type GenericHTTPSCreds interface {
	HasClientCert() bool
	GetClientCertData() string
	GetClientCertKey() string
	Environ() (io.Closer, []string, error)
}

func NewGitHubAppCreds

func NewGitHubAppCreds(appID int64, appInstallId int64, privateKey string, baseURL string, repoURL string, clientCertData string, clientCertKey string, insecure bool) GenericHTTPSCreds

NewGitHubAppCreds provide github app credentials

func NewHTTPSCreds

func NewHTTPSCreds(username string, password string, clientCertData string, clientCertKey string, insecure bool) GenericHTTPSCreds

type GitHubAppCreds

type GitHubAppCreds struct {
	// contains filtered or unexported fields
}

GitHubAppCreds to authenticate as GitHub application

func (GitHubAppCreds) Environ

func (g GitHubAppCreds) Environ() (io.Closer, []string, error)

func (GitHubAppCreds) GetClientCertData

func (g GitHubAppCreds) GetClientCertData() string

func (GitHubAppCreds) GetClientCertKey

func (g GitHubAppCreds) GetClientCertKey() string

func (GitHubAppCreds) HasClientCert

func (g GitHubAppCreds) HasClientCert() bool

type HTTPSCreds

type HTTPSCreds struct {
	// contains filtered or unexported fields
}

HTTPS creds implementation

func (HTTPSCreds) Environ

func (c HTTPSCreds) Environ() (io.Closer, []string, error)

Get additional required environment variables for executing git client to access specific repository via HTTPS.

func (HTTPSCreds) GetClientCertData

func (c HTTPSCreds) GetClientCertData() string

func (HTTPSCreds) GetClientCertKey

func (c HTTPSCreds) GetClientCertKey() string

func (HTTPSCreds) HasClientCert

func (g HTTPSCreds) HasClientCert() bool

type NopCloser

type NopCloser struct {
}

nop implementation

func (NopCloser) Close

func (c NopCloser) Close() error

type NopCreds

type NopCreds struct {
}

func (NopCreds) Environ

func (c NopCreds) Environ() (io.Closer, []string, error)

type Refs

type Refs struct {
	Branches []string
	Tags     []string
}

this should match reposerver/repository/repository.proto/RefsList

type RevisionMetadata

type RevisionMetadata struct {
	Author  string
	Date    time.Time
	Tags    []string
	Message string
}

type SSHCreds

type SSHCreds struct {
	// contains filtered or unexported fields
}

SSH implementation

func NewSSHCreds

func NewSSHCreds(sshPrivateKey string, caPath string, insecureIgnoreHostKey bool) SSHCreds

func (SSHCreds) Environ

func (c SSHCreds) Environ() (io.Closer, []string, error)