Documentation
¶
Overview ¶
Package connections manages connections between VCS repositories and OTF resources, e.g. workspaces, modules.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewService ¶
Types ¶
type ConnectOptions ¶
type ConnectOptions struct {
ConnectionType // OTF resource type
VCSProviderID string // vcs provider of repo
ResourceID string // ID of OTF resource
RepoPath string
}
type Connection ¶
Connection is a connection between a VCS repo and an OTF resource.
type ConnectionService ¶
type ConnectionService Service
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
}
type Options ¶
type Options struct {
logr.Logger
vcsprovider.VCSProviderService
repohooks.RepohookService
*sql.DB
}
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 connections between OTF resources and VCS repos
type SynchroniseOptions ¶
Click to show internal directories.
Click to hide internal directories.