common

package
v0.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const DefaultProjectFileName = "orca.project.yaml"
View Source 
const DefaultWorkspaceFileName = "orca.workspace.yaml"

Variables

This section is empty.

Functions

This section is empty.

Types

type ComposeFiles 

type ComposeFiles struct {
	Primary string
	Extras  []ExtraComposeFile
}

type ContextResolver 

type ContextResolver struct {
	// contains filtered or unexported fields
}

func NewContextResolver 

func NewContextResolver(cfg configManager, workspaceRepo workspaceRepository) *ContextResolver

func (*ContextResolver) Resolve 

func (c *ContextResolver) Resolve(ws string, project string) (ExecutionContext, error)

type EnvFile 

type EnvFile struct {
	Path string
}

type ErrArgumentRequired 

type ErrArgumentRequired struct {
	Name  string
	Index int
}

func (ErrArgumentRequired) Error 

func (err ErrArgumentRequired) Error() string

type ErrCommandExecutionFailed 

type ErrCommandExecutionFailed struct {
	Msg string
}

func (ErrCommandExecutionFailed) Error 

func (err ErrCommandExecutionFailed) Error() string

type ErrConfigIsNotValidYAML 

type ErrConfigIsNotValidYAML struct {
	Path       string
	ParseError string
}

func (ErrConfigIsNotValidYAML) Error 

func (err ErrConfigIsNotValidYAML) Error() string

type ErrCouldNotDetermineCurrentBranch 

type ErrCouldNotDetermineCurrentBranch struct{}

func (ErrCouldNotDetermineCurrentBranch) Error 

func (err ErrCouldNotDetermineCurrentBranch) Error() string

type ErrCouldNotDetermineWorkspace 

type ErrCouldNotDetermineWorkspace struct {
	Message string
}

func (ErrCouldNotDetermineWorkspace) Error 

func (err ErrCouldNotDetermineWorkspace) Error() string

type ErrDirectoryAlreadyExists 

type ErrDirectoryAlreadyExists struct {
	Path string
}

func (ErrDirectoryAlreadyExists) Error 

func (err ErrDirectoryAlreadyExists) Error() string

type ErrDirectoryDoesNotMatchOrigin 

type ErrDirectoryDoesNotMatchOrigin struct {
	Path   string
	Origin string
}

func (ErrDirectoryDoesNotMatchOrigin) Error 

func (err ErrDirectoryDoesNotMatchOrigin) Error() string

type ErrFileNotFound 

type ErrFileNotFound struct {
	Path string
}

func (ErrFileNotFound) Error 

func (err ErrFileNotFound) Error() string

type ErrInvalidArchive 

type ErrInvalidArchive struct{}

func (ErrInvalidArchive) Error 

func (err ErrInvalidArchive) Error() string

type ErrInvalidExecutionContext 

type ErrInvalidExecutionContext struct {
	Msg string
}

func (ErrInvalidExecutionContext) Error 

func (err ErrInvalidExecutionContext) Error() string

type ErrInvalidInput 

type ErrInvalidInput struct {
	To  string
	Msg string
}

func (ErrInvalidInput) Error 

func (err ErrInvalidInput) Error() string

type ErrInvalidProjectDependency 

type ErrInvalidProjectDependency struct {
	ProjectName        string
	InvalidRequirement string
}

func (ErrInvalidProjectDependency) Error 

func (err ErrInvalidProjectDependency) Error() string

type ErrInvalidSemVerValue 

type ErrInvalidSemVerValue struct {
	Value string
}

func (ErrInvalidSemVerValue) Error 

func (err ErrInvalidSemVerValue) Error() string

type ErrInvalidStrategy 

type ErrInvalidStrategy struct {
	Msg string
}

func (ErrInvalidStrategy) Error 

func (err ErrInvalidStrategy) Error() string

type ErrInvalidValueForOverlayModifier 

type ErrInvalidValueForOverlayModifier struct {
	Label   string
	Message string
	Service string
}

func (ErrInvalidValueForOverlayModifier) Error 

func (err ErrInvalidValueForOverlayModifier) Error() string

type ErrNoBranchesFound 

type ErrNoBranchesFound struct{}

func (ErrNoBranchesFound) Error 

func (err ErrNoBranchesFound) Error() string

type ErrNotImplemented 

type ErrNotImplemented struct {
	Msg string
}

func (ErrNotImplemented) Error 

func (err ErrNotImplemented) Error() string

type ErrProjectConfigNotFound 

type ErrProjectConfigNotFound struct {
	Path string
}

func (ErrProjectConfigNotFound) Error 

func (err ErrProjectConfigNotFound) Error() string

type ErrRateLimitedByApi 

type ErrRateLimitedByApi struct {
	Api string
}

func (ErrRateLimitedByApi) Error 

func (err ErrRateLimitedByApi) Error() string

type ErrRepositoryAlreadyCloned 

type ErrRepositoryAlreadyCloned struct {
	RepoURL string
}

func (ErrRepositoryAlreadyCloned) Error 

func (err ErrRepositoryAlreadyCloned) Error() string

type ErrTooManyArguments 

type ErrTooManyArguments struct {
	Expected int
}

func (ErrTooManyArguments) Error 

func (err ErrTooManyArguments) Error() string

type ErrToolNotFoundOnSystem 

type ErrToolNotFoundOnSystem struct {
	Tool string
}

func (ErrToolNotFoundOnSystem) Error 

func (err ErrToolNotFoundOnSystem) Error() string

type ErrToolsNotFoundOnSystem 

type ErrToolsNotFoundOnSystem struct {
	Errs []ErrToolNotFoundOnSystem
}

func (ErrToolsNotFoundOnSystem) Error 

func (err ErrToolsNotFoundOnSystem) Error() string

type ErrUnexpectedApiError 

type ErrUnexpectedApiError struct {
	Msg string
}

func (ErrUnexpectedApiError) Error 

func (err ErrUnexpectedApiError) Error() string

type ErrUnknownExtension 

type ErrUnknownExtension struct {
	Name string
}

func (ErrUnknownExtension) Error 

func (err ErrUnknownExtension) Error() string

type ErrUnknownProject 

type ErrUnknownProject struct {
	Name string
}

func (ErrUnknownProject) Error 

func (err ErrUnknownProject) Error() string

type ErrUnknownService 

type ErrUnknownService struct {
	Name string
}

func (ErrUnknownService) Error 

func (err ErrUnknownService) Error() string

type ErrUnknownTool 

type ErrUnknownTool struct {
	Tool string
}

func (ErrUnknownTool) Error 

func (err ErrUnknownTool) Error() string

type ErrUnknownWorkspace 

type ErrUnknownWorkspace struct {
	Name string
}

func (ErrUnknownWorkspace) Error 

func (err ErrUnknownWorkspace) Error() string

type ErrUnsupportedArchitecture 

type ErrUnsupportedArchitecture struct {
	Arch string
}

func (ErrUnsupportedArchitecture) Error 

func (err ErrUnsupportedArchitecture) Error() string

type ErrUnsupportedOS 

type ErrUnsupportedOS struct {
	OS string
}

func (ErrUnsupportedOS) Error 

func (err ErrUnsupportedOS) Error() string

type ErrUnsupportedProvisioner 

type ErrUnsupportedProvisioner struct {
	Message string
}

func (ErrUnsupportedProvisioner) Error 

func (err ErrUnsupportedProvisioner) Error() string

type ErrUserAbortedExecution 

type ErrUserAbortedExecution struct{}

func (ErrUserAbortedExecution) Error 

func (err ErrUserAbortedExecution) Error() string

type ErrVersionNotFound 

type ErrVersionNotFound struct {
	Version string
}

func (ErrVersionNotFound) Error 

func (err ErrVersionNotFound) Error() string

type ErrWorkspaceAlreadyExists 

type ErrWorkspaceAlreadyExists struct {
	Name string
}

func (ErrWorkspaceAlreadyExists) Error 

func (err ErrWorkspaceAlreadyExists) Error() string

type ErrWorkspaceConfigNotFound 

type ErrWorkspaceConfigNotFound struct {
	Path string
}

func (ErrWorkspaceConfigNotFound) Error 

func (err ErrWorkspaceConfigNotFound) Error() string

type ExampleFileProvisioner 

type ExampleFileProvisioner struct {
	Src    string
	Target string
	Type   ExampleFileProvisionerType
}

type ExampleFileProvisionerType 

type ExampleFileProvisionerType string
const ExampleFileProvisionerTypeDotenv ExampleFileProvisionerType = "dotenv"

type ExecutionContext 

type ExecutionContext struct {
	Workspace        *Workspace
	Project          *Project
	WorkingDirectory string
}

type Extension 

type Extension struct {
	Name        string
	Chdir       string
	Command     string
	Service     string
	DefaultArgs []string
}

type ExtraComposeFile 

type ExtraComposeFile struct {
	Path string
	When []LoaderCondition
}

type LoaderCondition 

type LoaderCondition struct {
	OS       string
	Arch     string
	Property LoaderPropertyCondition
}

type LoaderPropertyCondition 

type LoaderPropertyCondition struct {
	Name  string
	Value any
}

type NetworkOverlayConfig 

type NetworkOverlayConfig struct {
	Enabled        bool
	CreateIn       string
	DisableAliases bool
	AliasPattern   string
}

type OverlayConfig 

type OverlayConfig struct {
	Network NetworkOverlayConfig
}

type Project 

type Project struct {
	Name             string
	RepositoryConfig ProjectRepositoryConfig
	ProjectDir       string
	Requires         []string
	Config           ProjectConfig
	IsRegistered     bool
}

func (Project) EnvFilePaths 

func (p Project) EnvFilePaths() []string

func (Project) FindExtension 

func (p Project) FindExtension(name string) (Extension, error)

func (Project) GetChildren 

func (p Project) GetChildren() []string

func (Project) GetKey 

func (p Project) GetKey() string

func (Project) GetName 

func (p Project) GetName() string

func (Project) GetParents 

func (p Project) GetParents() []string

type ProjectConfig 

type ProjectConfig struct {
	ComposeFiles    ComposeFiles
	Provisioners    []Provisioner
	EnvFiles        []EnvFile
	Properties      []Property
	Hosts           []string
	TLSCertificates []string
	Extensions      []Extension
}

type ProjectMeta 

type ProjectMeta struct {
	Name          string
	Path          string
	WorkspaceName string
	Repository    ProjectRepositoryMeta
}

type ProjectRepositoryConfig 

type ProjectRepositoryConfig struct {
	SSH  string
	Self bool
}

type ProjectRepositoryMeta 

type ProjectRepositoryMeta struct {
	SSH  string
	Self bool
}

type Property 

type Property struct {
	Name    string
	Type    string
	Default any
}

type Provisioner 

type Provisioner struct {
	ExampleFile *ExampleFileProvisioner
}

type UnconfiguredProject 

type UnconfiguredProject struct {
	Name             string
	RepositoryConfig ProjectRepositoryConfig
}

type UnconfiguredWorkspace 

type UnconfiguredWorkspace struct {
	Name       string
	ConfigPath string
	Projects   []UnconfiguredProject
}

type Workspace 

type Workspace struct {
	Name          string
	ConfigPath    string
	Projects      []Project
	OverlayConfig OverlayConfig `yaml:"overlays"`
}

func (*Workspace) GetProject 

func (ws *Workspace) GetProject(name string) (*Project, error)

func (*Workspace) GetUniqueHosts 

func (ws *Workspace) GetUniqueHosts() []string

func (*Workspace) GetUniqueTLSCertificates 

func (ws *Workspace) GetUniqueTLSCertificates() []string

type WorkspaceMeta 

type WorkspaceMeta struct {
	Name     string
	Path     string
	Projects []ProjectMeta
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.