scm

Documentation

Index

• func GenerateSCMToken(config *api.SCMConfig) error
• func NewTagFromLatest(codeSource *api.CodeSource, scm *api.SCMConfig, tagName, description string) error
• func RegisterProvider(scmType api.SCMType, provider SCMProvider) error
• type EventType
• type SCMProvider
  • func GetSCMProvider(scmType api.SCMType) (SCMProvider, error)
• type WebHook

Functions

func GenerateSCMToken

func GenerateSCMToken(config *api.SCMConfig) error

GenerateSCMToken generates the SCM token according to the config. Make sure the type, server of the SCM is provided. If the SCM is Github, the username is required. If the access token is provided, it should be checked whether has authority of repos. Generate new token only when the username and password are provided at the same time.

func NewTagFromLatest

func NewTagFromLatest(codeSource *api.CodeSource, scm *api.SCMConfig, tagName, description string) error

func RegisterProvider

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

RegisterProvider registers SCM providers.

Types

type EventType

type EventType string

const (
	PullRequestEventType        EventType = "PullRequest"
	PullRequestCommentEventType EventType = "PullRequestComment"
	PushEventType               EventType = "Push"
	TagReleaseEventType         EventType = "TagRelease"
)

type SCMProvider

type SCMProvider interface {
	GetToken(scm *api.SCMConfig) (string, error)
	ListRepos(scm *api.SCMConfig) ([]api.Repository, error)
	ListBranches(scm *api.SCMConfig, repo string) ([]string, error)
	ListTags(scm *api.SCMConfig, repo string) ([]string, error)
	CheckToken(scm *api.SCMConfig) bool
	NewTagFromLatest(scm *api.SCMConfig, tagName, description, commitID, url string) error
	CreateWebHook(scm *api.SCMConfig, repoURL string, webHook *WebHook) error
	DeleteWebHook(scm *api.SCMConfig, repoURL string, webHookUrl string) error
	// gitlib oauth function
	GetAuthCodeURL(state string, scmType api.SCMType) (string, error)
	Authcallback(code, state string) (string, error)
}

SCMProvider represents the interface of SCM provider. TODO(robin) Refactor this interface to avoid the SCM config param for each method.

func GetSCMProvider

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

GetSCMProvider gets the SCM provider by the type.

type WebHook

type WebHook struct {
	Events []EventType
	Url    string
}

WebHook represents the params for SCM webhook.