devcontainer

Documentation

Index

• Constants
• type Runner
  • func NewRunner(agentPath, agentDownloadURL string, ...) (*Runner, error)
  • func (r *Runner) Build(options config.BuildOptions) (string, error)
  • func (r *Runner) Delete(labels []string, deleteVolumes bool) error
  • func (r *Runner) FindDevContainer(ctx context.Context) (*config.ContainerDetails, error)
  • func (r *Runner) Stop() error
  • func (r *Runner) Up(options UpOptions) (*config.Result, error)
• type UpOptions
• type WorkspaceConfig

Constants

const (
	ConfigFilesLabel                = "com.docker.compose.project.config_files"
	FeaturesBuildOverrideFilePrefix = "docker-compose.devcontainer.build"
	FeaturesStartOverrideFilePrefix = "docker-compose.devcontainer.containerFeatures"
)

Types

type Runner

type Runner struct {
	Driver driver.Driver

	WorkspaceConfig  *provider2.AgentWorkspaceInfo
	AgentPath        string
	AgentDownloadURL string

	LocalWorkspaceFolder string
	SubstitutionContext  *config.SubstitutionContext

	ID  string
	Log log.Logger
}

func NewRunner

func NewRunner(agentPath, agentDownloadURL string, workspaceConfig *provider2.AgentWorkspaceInfo, log log.Logger) (*Runner, error)

func (*Runner) Build

func (r *Runner) Build(options config.BuildOptions) (string, error)

func (*Runner) Delete

func (r *Runner) Delete(labels []string, deleteVolumes bool) error

func (*Runner) FindDevContainer

func (r *Runner) FindDevContainer(ctx context.Context) (*config.ContainerDetails, error)

func (*Runner) Stop

func (r *Runner) Stop() error

func (*Runner) Up

func (r *Runner) Up(options UpOptions) (*config.Result, error)

type UpOptions

type UpOptions struct {
	PrebuildRepositories []string

	NoBuild bool

	ForceBuild bool
	Recreate   bool
}

type WorkspaceConfig

type WorkspaceConfig struct {
	WorkspaceMount        string
	RemoteWorkspaceFolder string
}