scm

Documentation

Index

• func CloneRepo(token string, codeSource *api.CodeSource, ref string, folder string) (string, error)
• func CloneRepos(token string, codeSources *api.CodeCheckoutStage, ref string) (string, error)
• func GetCloneDir() string
• func GetCommitID(codeSource *api.CodeSource, folder string) (string, error)
• func GetCommitLog(codeSource *api.CodeSource, folder string) (api.CommitLog, error)
• func GetRepoName(codeSource *api.CodeSource) (string, error)
• func RegisterProvider(scmType api.SCMType, provider SCMProvider) error
• type SCMProvider
  • func GetSCMProvider(scmType api.SCMType) (SCMProvider, error)

Functions

func CloneRepo

func CloneRepo(token string, codeSource *api.CodeSource, ref string, folder string) (string, error)

CloneRepo represents clone repo to `destPath`, `ref` is for main repo.

func CloneRepos

func CloneRepos(token string, codeSources *api.CodeCheckoutStage, ref string) (string, error)

CloneRepo represents clone main repo and dep repos.

func GetCloneDir

func GetCloneDir() string

GetCloneDir returns the clone dir.

func GetCommitID

func GetCommitID(codeSource *api.CodeSource, folder string) (string, error)

func GetCommitLog

func GetCommitLog(codeSource *api.CodeSource, folder string) (api.CommitLog, error)

func GetRepoName

func GetRepoName(codeSource *api.CodeSource) (string, error)

func RegisterProvider

func RegisterProvider(scmType api.SCMType, provider SCMProvider) error

RegisterProvider registers SCM providers.

Types

type SCMProvider

type SCMProvider interface {
	Clone(token, url, ref, destPath string) (string, error)
	GetCommitID(repoPath string) (string, error)
	GetCommitLog(repoPath string) api.CommitLog
}

func GetSCMProvider

func GetSCMProvider(scmType api.SCMType) (SCMProvider, error)

GetSCMProvider gets the SCM provider by the type.