Documentation
¶
Index ¶
- Constants
- func GetContainerEntrypointAndArgs(mergedConfig *config.MergedDevContainerConfig, ...) (string, []string)
- func GetRunnerIDFromWorkspace(workspace *provider2.Workspace) string
- func GetStartScript(mergedConfig *config.MergedDevContainerConfig) string
- type CommandParams
- type DeleteOptions
- type GetWorkspaceConfigResult
- type Runner
- type UpOptions
Constants ¶
View Source
const ( ConfigFilesLabel = "com.docker.compose.project.config_files" FeaturesBuildOverrideFilePrefix = "docker-compose.devcontainer.build" FeaturesStartOverrideFilePrefix = "docker-compose.devcontainer.containerFeatures" )
View Source
const ( DevsyExtraEnvVar = "DEVSY" RemoteContainersExtraEnvVar = "REMOTE_CONTAINERS" DefaultEntrypoint = `` /* 183-byte string literal not displayed */ )
Variables ¶
This section is empty.
Functions ¶
func GetContainerEntrypointAndArgs ¶
func GetContainerEntrypointAndArgs( mergedConfig *config.MergedDevContainerConfig, imageDetails *config.ImageDetails, ) (string, []string)
func GetStartScript ¶
func GetStartScript(mergedConfig *config.MergedDevContainerConfig) string
Types ¶
type CommandParams ¶ added in v1.3.1
type CommandParams struct {
User string
Command string
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
}
CommandParams groups the inputs for running a command inside the dev container.
type DeleteOptions ¶ added in v1.1.0
type DeleteOptions struct {
RemoveVolumes bool
}
type GetWorkspaceConfigResult ¶
type GetWorkspaceConfigResult struct {
IsImage bool `json:"isImage"`
IsGitRepository bool `json:"isGitRepository"`
IsLocal bool `json:"isLocal"`
ConfigPaths []string `json:"configPaths"`
}
func FindDevcontainerFiles ¶
func FindFilesInLocalDir ¶
func FindFilesInLocalDir( rawSource string, maxDepth int, ) (*GetWorkspaceConfigResult, error)
type Runner ¶
type Runner interface {
Up(ctx context.Context, options UpOptions, timeout time.Duration) (*config.Result, error)
Build(ctx context.Context, options provider2.BuildOptions) (string, error)
Find(ctx context.Context) (*config.ContainerDetails, error)
Command(ctx context.Context, params CommandParams) error
Stop(ctx context.Context) error
Delete(ctx context.Context, options DeleteOptions) error
Logs(ctx context.Context, writer io.Writer) error
}
type UpOptions ¶
type UpOptions struct {
provider2.CLIOptions
// NoBuild is set by the container tunnel to force pre-built images; it is
// distinct from the embedded CLIOptions.NoBuild used by the build command.
NoBuild bool
// RegistryCache is sourced from AgentWorkspaceInfo.RegistryCache (a provider
// context option), not from CLIOptions, so it is a separate field.
RegistryCache string
}
Source Files
¶
Click to show internal directories.
Click to hide internal directories.