devcontainer

Documentation

Index

• Constants
• func GetRunnerIDFromWorkspace(workspace *provider2.Workspace) string
• type Runner
  • func NewRunner(agentPath, agentDownloadURL string, ...) (*Runner, error)
  • func (r *Runner) Build(ctx context.Context, options config.BuildOptions) (string, error)
  • func (r *Runner) CommandDevContainer(ctx context.Context, containerId string, user string, command string, ...) error
  • func (r *Runner) Delete(ctx context.Context, labels []string, deleteVolumes bool) error
  • func (r *Runner) FindDevContainer(ctx context.Context) (*config.ContainerDetails, error)
  • func (r *Runner) Stop(ctx context.Context) error
  • func (r *Runner) Up(ctx context.Context, 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"
)

Functions

func GetRunnerIDFromWorkspace

func GetRunnerIDFromWorkspace(workspace *provider2.Workspace) string

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(ctx context.Context, options config.BuildOptions) (string, error)

func (*Runner) CommandDevContainer

func (r *Runner) CommandDevContainer(
	ctx context.Context,
	containerId string,
	user string,
	command string,
	stdin io.Reader,
	stdout io.Writer,
	stderr io.Writer,
) error

func (*Runner) Delete

func (r *Runner) Delete(ctx context.Context, 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(ctx context.Context) error

func (*Runner) Up

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

type UpOptions

type UpOptions struct {
	provider2.CLIOptions

	NoBuild    bool
	ForceBuild bool
}

type WorkspaceConfig

type WorkspaceConfig struct {
	WorkspaceMount        string
	RemoteWorkspaceFolder string
}