git

Documentation

Index

• Constants
• func ExtractProjectPathFromURL(gitURL string) (string, error)
• func Register(kind string, constructor Constructor)
• type Commit
• type Constructor
• type Helper
  • func NewHelper(ctx context.Context, config *git.Repo) (Helper, error)
• type SearchParams
• type Tag

Constants

const (
	GitRefTypeBranch = "branch"
	GitRefTypeTag    = "tag"
	GitRefTypeCommit = "commit"
)

Functions

func ExtractProjectPathFromURL

func ExtractProjectPathFromURL(gitURL string) (string, error)

ExtractProjectPathFromURL extract git project path from gitURL.

func Register

func Register(kind string, constructor Constructor)

Types

type Commit

type Commit struct {
	ID      string
	Message string
}

type Constructor

type Constructor func(ctx context.Context, config *git.Repo) (Helper, error)

type Helper

type Helper interface {
	// GetCommit to get commit of a branch/tag/commitID for a specified git URL
	GetCommit(ctx context.Context, gitURL string, refType string, ref string) (*Commit, error)
	ListBranch(ctx context.Context, gitURL string, params *SearchParams) ([]string, error)
	ListTag(ctx context.Context, gitURL string, params *SearchParams) ([]string, error)
	GetHTTPLink(gitURL string) (string, error)
	GetCommitHistoryLink(gitURL string, commit string) (string, error)
	GetTagArchive(ctx context.Context, gitURL, tagName string) (*Tag, error)
}

Helper interface to do git operations

func NewHelper

func NewHelper(ctx context.Context, config *git.Repo) (Helper, error)

type SearchParams

type SearchParams struct {
	Filter     string
	PageNumber int
	PageSize   int
}

SearchParams contains parameters for searching operation

type Tag

type Tag struct {
	ShortID     string
	Name        string
	ArchiveData []byte
}