repo

Documentation

Overview

Package repo handles configuration of VCS repositories.

Index

• func NewService(opts Options) *service
• type ConnectOptions
• type Connection
• type ConnectionType
• type DisconnectOptions
• type Options
• type RepoService
• type Service

Functions

func NewService

func NewService(opts Options) *service

Types

type ConnectOptions

type ConnectOptions struct {
	ConnectionType // OTF resource type

	VCSProviderID string // vcs provider of repo
	ResourceID    string // ID of OTF resource
	RepoPath      string
	Tx            otf.DB // Optional tx for performing database ops within.
}

type Connection

type Connection struct {
	VCSProviderID string
	Repo          string
}

Connection is a connection between a VCS repo and an OTF resource.

type ConnectionType

type ConnectionType int

ConnectionType identifies the OTF resource type in a VCS connection.

const (
	WorkspaceConnection ConnectionType = iota
	ModuleConnection
)

type DisconnectOptions

type DisconnectOptions struct {
	ConnectionType // OTF resource type

	ResourceID string // ID of OTF resource
	Tx         otf.DB // Optional tx for performing database ops within.
}

type Options

type Options struct {
	logr.Logger

	CloudService cloud.Service

	otf.DB
	otf.HostnameService
	otf.Publisher
	VCSProviderService vcsprovider.Service
}

type RepoService

type RepoService = Service

type Service

type Service interface {
	// Connect adds a connection between a VCS repo and an OTF resource. A
	// webhook is created if one doesn't exist already.
	Connect(ctx context.Context, opts ConnectOptions) (*Connection, error)
	// Disconnect removes a connection between a VCS repo and an OTF
	// resource. If there are no more connections then its
	// webhook is removed.
	Disconnect(ctx context.Context, opts DisconnectOptions) error
}

Service manages VCS repositories