shell

type Artifact struct {
	Path    string        `json:"path" yaml:"path" template:"true"`
	Content io.ReadCloser `json:"-" yaml:"-"`
}

type Checkout struct {
	Mode       CheckoutMode `json:"mode,omitempty" yaml:"mode,omitempty"`
	URL        string       `json:"url,omitempty" yaml:"url,omitempty"`
	Path       string       `json:"path,omitempty" yaml:"path,omitempty"`
	Connection string       `json:"connection,omitempty" yaml:"connection,omitempty"`
	Ref        string       `json:"ref,omitempty" yaml:"ref,omitempty"`
	Depth      *int         `json:"depth,omitempty" yaml:"depth,omitempty"`
	// Since is a commit-ish. When set, the merge-base diff against HEAD is
	// folded into the reported `dirtyFiles`. Purely informational — it has no
	// bearing on what the worktree contains.
	Since string `json:"since,omitempty" yaml:"since,omitempty"`
	// Deprecated: no-op, retained so existing configs keep parsing. What a new
	// worktree contains is controlled by Worktree.Uncommitted and
	// Worktree.Ignored; dirtyFiles reporting is controlled by Since.
	Dirty    *Dirty    `json:"dirty,omitempty" yaml:"dirty,omitempty"`
	Worktree *Worktree `json:"worktree,omitempty" yaml:"worktree,omitempty"`
}

type CheckoutMode string

type CloneMode string

type Exec struct {
	Script      string
	Connections connection.ExecConnections
	Checkout    *connection.GitConnection
	Artifacts   []Artifact

	EnvVars []types.EnvVar
	DotEnv  []string
	Chroot  string
	BaseDir string
}

type ExecDetails struct {
	Stdout   string   `json:"stdout"`
	Stderr   string   `json:"stderr"`
	ExitCode int      `json:"exitCode"`
	Path     string   `json:"path"`
	Args     []string `json:"args"`

	// Any extra details about the command execution, e.g. git commit id, etc.
	Extra map[string]any `json:"extra,omitempty"`

	Error     error      `json:"-" yaml:"-"`
	Artifacts []Artifact `json:"-" yaml:"-"`
}

type Setup struct {
	Cwd         string                     `json:"cwd,omitempty" yaml:"cwd,omitempty"`
	BaseDir     string                     `json:"baseDir,omitempty" yaml:"baseDir,omitempty"`
	DotEnv      []string                   `json:"dotenv,omitempty" yaml:"dotenv,omitempty"`
	EnvVars     []types.EnvVar             `json:"envVars,omitempty" yaml:"envVars,omitempty"`
	Checkout    *Checkout                  `json:"checkout,omitempty" yaml:"checkout,omitempty"`
	Connections connection.ExecConnections `json:"connections,omitempty" yaml:"connections,omitempty"`
	Env         []string                   `json:"-" yaml:"-"`
}

type SetupResult struct {
	Env       []string
	Cwd       string
	Extra     map[string]any
	Artifacts []Artifact
	Cleanup   func() error
}

type Worktree struct {
	Mode   WorktreeMode `json:"mode,omitempty" yaml:"mode,omitempty"`
	Prefix string       `json:"prefix,omitempty" yaml:"prefix,omitempty"`
	Base   string       `json:"base,omitempty" yaml:"base,omitempty"`
	Path   string       `json:"path,omitempty" yaml:"path,omitempty"`
	Keep   bool         `json:"keep,omitempty" yaml:"keep,omitempty"`

	// Uncommitted controls whether staged, unstaged and untracked changes are
	// carried from the source repo into the new worktree. Nothing is ever
	// stashed — the source repo is never mutated.
	Uncommitted CloneMode `json:"uncommitted,omitempty" yaml:"uncommitted,omitempty"`
	// Ignored controls whether gitignored content (node_modules/, .env, build
	// caches) is copied into the new worktree. `git worktree add` never brings
	// it, so without this the worktree is missing everything .gitignore hides.
	Ignored CloneMode `json:"ignored,omitempty" yaml:"ignored,omitempty"`
}

type WorktreeMode string