scm

Documentation

Index

• Variables
• type CodeRepositoryRequest
• type CodeRepositoryResponse
• type SCM
  • func NewSCM() SCM
  • func ProvideSCM() SCM

Variables

var (
	ErrNoDefaultBranch = errors.New("no default branch")
)

var WireSet = wire.NewSet(
	ProvideSCM,
)

WireSet provides a wire set for this package.

Types

type CodeRepositoryRequest

type CodeRepositoryRequest struct {
	URL string `json:"url"`
}

type CodeRepositoryResponse

type CodeRepositoryResponse struct {
	URL               string `json:"url"`
	Branch            string `json:"branch,omitempty"`
	CodeRepoIsPrivate bool   `json:"is_private"`
}

type SCM

type SCM interface {
	// RepoNameAndDevcontainerConfig fetches repository name & devcontainer config file from the given repo and branch.
	RepoNameAndDevcontainerConfig(
		ctx context.Context,
		gitspaceConfig *types.GitspaceConfig,
	) (string, *types.DevcontainerConfig, error)

	// CheckValidCodeRepo checks if the current URL is a valid and accessible code repo,
	// input can be connector info, user token etc.
	CheckValidCodeRepo(ctx context.Context, request CodeRepositoryRequest) (*CodeRepositoryResponse, error)
}

func NewSCM

func NewSCM() SCM

func ProvideSCM

func ProvideSCM() SCM