devcontainer

Documentation

Index

• Constants
• func GetContainerEntrypointAndArgs(mergedConfig *config.MergedDevContainerConfig, ...) (string, []string)
• func GetRunnerIDFromWorkspace(workspace *provider2.Workspace) string
• func GetStartScript(mergedConfig *config.MergedDevContainerConfig) string
• type GetWorkspaceConfigResult
  • func FindDevcontainerFiles(ctx context.Context, rawSource, tmpDirPath string, maxDepth int, ...) (*GetWorkspaceConfigResult, error)
  • func FindFilesInGitRepo(ctx context.Context, ...) (*GetWorkspaceConfigResult, error)
  • func FindFilesInLocalDir(rawSource string, maxDepth int, log log.Logger) (*GetWorkspaceConfigResult, error)
• type Runner
  • func NewRunner(agentPath, agentDownloadURL string, ...) (Runner, error)
• type UpOptions

Constants

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

const (
	DevPodExtraEnvVar           = "DEVPOD"
	RemoteContainersExtraEnvVar = "REMOTE_CONTAINERS"
	WorkspaceIDExtraEnvVar      = "DEVPOD_WORKSPACE_ID"
	WorkspaceUIDExtraEnvVar     = "DEVPOD_WORKSPACE_UID"
)

Functions

func GetContainerEntrypointAndArgs

func GetContainerEntrypointAndArgs(mergedConfig *config.MergedDevContainerConfig, imageDetails *config.ImageDetails) (string, []string)

func GetRunnerIDFromWorkspace

func GetRunnerIDFromWorkspace(workspace *provider2.Workspace) string

func GetStartScript

func GetStartScript(mergedConfig *config.MergedDevContainerConfig) string

Types

type GetWorkspaceConfigResult

type GetWorkspaceConfigResult struct {
	IsImage         bool     `json:"isImage"`
	IsGitRepository bool     `json:"isGitRepository"`
	IsLocal         bool     `json:"isLocal"`
	ConfigPaths     []string `json:"configPaths"`
}

func FindDevcontainerFiles

func FindDevcontainerFiles(ctx context.Context, rawSource, tmpDirPath string, maxDepth int, log log.Logger) (*GetWorkspaceConfigResult, error)

func FindFilesInGitRepo

func FindFilesInGitRepo(ctx context.Context, gitRepository, gitPRReference, gitBranch, gitCommit, gitSubDir, tmpDirPath string, maxDepth int, log log.Logger) (*GetWorkspaceConfigResult, error)

func FindFilesInLocalDir

func FindFilesInLocalDir(rawSource string, maxDepth int, log log.Logger) (*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,
		user string,
		command string,
		stdin io.Reader,
		stdout io.Writer,
		stderr io.Writer,
	) error

	Stop(ctx context.Context) error

	Delete(ctx context.Context) error

	Logs(ctx context.Context, writer io.Writer) error
}

func NewRunner

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

type UpOptions

type UpOptions struct {
	provider2.CLIOptions

	NoBuild       bool
	ForceBuild    bool
	RegistryCache string
}