store

type Artifact struct {
	// Revision is the immutable revision this artifact was published for.
	Revision Revision
	// Path is the absolute directory holding the revision's deployable
	// contents.
	Path string
}

type GCOptions struct {
	// RetentionRecords is the number of most-recently-modified unreferenced
	// artifacts that are always kept, regardless of RetentionTTL.
	// Mirrors Flux's --artifact-retention-records.
	RetentionRecords int

	// RetentionTTL is how long an unreferenced artifact beyond
	// RetentionRecords is kept before Sweep is allowed to remove it.
	// Mirrors Flux's --artifact-retention-ttl.
	RetentionTTL time.Duration
}

type GCResult struct {
	// Kept lists every artifact Sweep decided not to remove: referenced
	// (live), within RetentionRecords, or younger than RetentionTTL.
	Kept []Artifact

	// Removed lists every artifact Sweep deleted.
	Removed []Artifact
}

type GitStore struct {
	// contains filtered or unexported fields
}

type GitStoreOptions struct {
	// Log receives debug/info output. Required.
	Log *slog.Logger
	// CloneURL is the repository to fetch from. Required.
	CloneURL string
	// BaseDir is the store's private directory: it holds the mirror clone
	// at "<BaseDir>/mirror" and published artifacts under
	// "<BaseDir>/artifacts/<revision>". Required.
	BaseDir string

	Private                 bool
	SSHPrivateKey           string
	SSHPrivateKeyPassphrase string
	AccessToken             string
	SkipTLSVerify           bool
	ProxyOptions            transport.ProxyOptions
	// CloneSubmodules enables submodule materialization in Publish, via
	// git.ExportTree's own fetch-and-recurse logic. It has no effect on
	// Resolve/the mirror clone itself: the mirror never needs its
	// submodules checked out, since Publish reads tree objects, not the
	// mirror's worktree.
	CloneSubmodules bool
	// SkipAbsoluteSymlinks allows Git includes to omit unrelated absolute
	// links during export. Regular Git sources keep the strict default.
	SkipAbsoluteSymlinks bool
	// Depth is the shallow-clone depth passed to the underlying sync.
	// 0 clones full history.
	Depth int
}

type Mirror struct {
	// Repository is the mirrored repository in "<host>/<owner>/<repo>" form.
	// A repository used as a submodule by several stores has a mirror in each.
	// It is empty if Err is set and the repository is unknown.
	Repository string
	// Path is the mirror's directory, or the directory that could not be
	// listed if Err is set.
	Path string
	// Owner is the base directory of the store whose GC gate protects the
	// mirror: the store itself, or for a Compose Git include store the store
	// that published the artifacts it is nested in.
	Owner string
	// Err reports why the mirror could not be inspected, e.g. an unreadable
	// configuration.
	Err error
}

type OCIStore struct {
	// contains filtered or unexported fields
}

type OCIStoreOptions struct {
	// Log receives debug/info output. Defaults to slog.Default().
	Log *slog.Logger
	// ArtifactRef is the OCI reference to resolve and pull from,
	// e.g. "ghcr.io/org/repo:latest". Required.
	ArtifactRef string
	// BaseDir is the store's private directory: published artifacts live
	// under "<BaseDir>/artifacts/<digest>". Required.
	BaseDir string
	// CustomTarget selects a non-default ".doco-cd.<target>.y(a)ml" config
	// inside the artifact, matching the deployment's CustomTarget setting.
	CustomTarget string

	TrustPolicy         config.OciTrustPolicy
	TrustPolicyOverride config.OciTrustPolicyOverride
	VerifyMaxWorkers    uint
}

type Revision string

type Store interface {
	// Resolve maps ref (a branch, tag, "latest", or already a Revision) to
	// the Revision it currently points to. It may contact the remote (a Git
	// fetch, a registry HEAD/manifest request) but never modifies a
	// previously published Artifact.
	Resolve(ctx context.Context, ref string) (Revision, error)

	// Publish materializes revision into a read-only Artifact directory and
	// returns it. If an Artifact for revision has already been published,
	// it is returned as-is without redoing the work. Publish is safe to
	// call concurrently for the same or different revisions.
	Publish(ctx context.Context, revision Revision) (Artifact, error)

	// Lookup returns the Artifact for revision if it has already been
	// published, without publishing it. The second return value is false
	// if no artifact exists yet.
	Lookup(revision Revision) (Artifact, bool, error)

	// List returns every Artifact currently published by this store, e.g.
	// for garbage collection or migration.
	List() ([]Artifact, error)
}