gitwriteback

type Request struct {
	// Dir is the absolute path of the provisioned tree. It must be a git
	// repository — gitprovision left one there — and the caller is responsible
	// for having confined it.
	Dir string
	// Workspace is the workspace the tree was provisioned from. It supplies
	// the push remote: a push goes to Workspace.Repo and nowhere else.
	Workspace executor.Workspace
	// WriteBack says which mode to run and what to name the branch.
	WriteBack executor.WriteBack
	// Credential authenticates the push. The zero value means an
	// unauthenticated push, which only works for a repository that accepts
	// anonymous writes — that is, essentially never, so a push mode request
	// without one fails with a legible error rather than a git prompt.
	Credential executor.GitCredential
	// BaseSHA is the commit the workspace was provisioned at. Empty means
	// "read it from the repository", which is right for the ordinary case;
	// a caller that recorded it before the harness ran should pass it, because
	// a harness that moved HEAD itself would otherwise shrink the range and
	// silently drop its own earlier commits.
	BaseSHA string
	// BundlePath is where a bundle-mode write-back writes its file. Empty
	// means a temporary file this package creates and the caller must remove;
	// Result.BundlePath always names the file that exists.
	BundlePath string
	// ExitCode is the harness's exit status, and OnlyOnSuccess decides whether
	// it gates the write-back. See OnlyOnSuccess.
	ExitCode int
	// OnlyOnSuccess refuses to write back the work of a failed task.
	//
	// It defaults to off in the zero Request because a caller has to opt into
	// a policy this consequential, and every caller in the tree opts in. The
	// reasoning: a harness that exited non-zero left the tree in whatever state
	// it was in when it died — a half-applied refactor, a partially generated
	// file — and merging that is worse than losing it, because the loss is
	// visible and the half-change is not.
	OnlyOnSuccess bool
	// Emit receives progress as it completes, already redacted. May be nil.
	Emit func(string)
	// Host is how the machine names itself in a diagnostic. Empty falls back
	// to gitprovision.HostLabel("machine").
	Host string
	// Timeout bounds the whole write-back. 0 means DefaultTimeout.
	Timeout time.Duration
	// GitCA is the hub's own CA, trusted for the URLs it names and nothing
	// else, for a push through a git proxy serving a certificate the hub
	// issued (Task 20409). See gitprovision.Request.GitCA.
	GitCA *executor.GitCA
}

type Result struct {
	executor.WriteBackResult
	// BundlePath names the bundle file on disk, for mode bundle. The caller
	// owns the file and is responsible for removing it.
	BundlePath string
}