scm

Documentation

Index

• func Unmarshal(scm map[string]interface{}) (Scm, PullRequest, error)
• type MockScm
  • func (m *MockScm) GetChangedFiles(workingDir string) ([]string, error)
  • func (m *MockScm) GetDirectory() (directory string)
• type PullRequest
• type Scm

Functions

func Unmarshal

func Unmarshal(scm map[string]interface{}) (Scm, PullRequest, error)

Unmarshal parses a scm struct like git or github and returns a scm interface

Types

type MockScm

type MockScm struct {
	Scm
	WorkingDir   string
	ChangedFiles []string
	Err          error
}

MockScm is a stub implementation of the `Scm` interface to be used in our unit test suites. It stores the expected WorkingDir

func (*MockScm) GetChangedFiles

func (m *MockScm) GetChangedFiles(workingDir string) ([]string, error)

func (*MockScm) GetDirectory

func (m *MockScm) GetDirectory() (directory string)

type PullRequest

type PullRequest interface {
	CreatePullRequest(title, changelog, pipelineReport string) error
}

PullRequest interface defines required funcions to be an pullRequest

type Scm

type Scm interface {
	Add(files []string) error
	Clone() (string, error)
	Checkout() error
	GetDirectory() (directory string)
	Init(source string, pipelineID string) error
	Push() error
	Commit(message string) error
	Clean() error
	PushTag(tag string) error
	GetChangedFiles(workingDir string) ([]string, error)
}

Scm is an interface that offers common functions for a source control manager like git or github