gitworkspace

type Command struct {
	// Alias identifies this command's Output in the response. It must be unique
	// within one Exec batch.
	Alias string
	// Bin is the executable name, such as "git". The backend decides which
	// binary it resolves to.
	Bin string
	// Args are the command-line arguments. For git, Args[0] is the subcommand;
	// global options and identity belong to the backend, not here.
	Args []string
	// Stdin is optional standard input.
	Stdin string
}

type Factory interface {
	// For returns a Workspace for the given repository. Cancelling ctx aborts
	// any running command and ends the Workspace, so ctx bounds its lifetime.
	For(ctx context.Context, repo string) (Workspace, error)
}

type Output struct {
	// Alias matches the Command that produced this output.
	Alias string
	// ExitCode is the process exit code. It is unspecified when Skipped is set.
	ExitCode int32
	// Skipped reports that the command did not run because an earlier command
	// in the same batch failed.
	Skipped bool
	// Stdout is the captured standard output.
	Stdout string
	// Stderr is the captured standard error.
	Stderr string
}

type Workspace interface {
	// Exec runs a batch and returns one Output per command, in order. A
	// command that exits non-zero is reported in its Output, not as an error;
	// the error is reserved for failing to run the batch at all.
	Exec(commands []Command) ([]Output, error)
	// Close releases the workspace and its resources.
	Close() error
}