pin

type CommitOptions struct {
	// OnProgress is called at each phase boundary. Nil means no progress.
	OnProgress func(phase string)
	// SkipNewWorkflowEntries forces the Commit phase to skip workflows with no existing lockfile entry.
	SkipNewWorkflowEntries bool
}

type Entry struct {
	Hostname     string
	NWO          string
	Ref          string
	SHA          string
	ObservedSHA  string
	Resolution   Resolution
	Issue        string
	Reason       string
	Suggestion   string
	AutoFixedRef string // original ref before sane-release rewrite
	OnBranch     string
	Tag          string
	Workflows    []string
	RequiredBy   []string
	Direct       bool
	// RenamedFrom lists the lockfile keys this pin had before a
	// same-repository rename, so their recorded `uses:` carry over.
	RenamedFrom []string
	FullScan    bool
	// ReRecorded marks a full-SHA pin whose entry recorded the SHA itself
	// as its ref; Commit records the tag or branch found for it instead.
	ReRecorded bool
	// FromLock marks an entry taken from the lockfile without reading its
	// manifest (see dep.Dependency.FromLock).
	FromLock bool
}

type EntryRepair struct {
	Key string
	Ref string
	// Workflows are the written workflows that reach the entry; the repair
	// applies only while one of them is written.
	Workflows []string
}

type PlanOptions struct {
	Resolver  *resolve.Resolver
	Tagger    *tag.Lister
	Store     *lockfile.State
	Pool      *pinpool.Pool
	RepoOwner string // for same-owner narrowing skip
	RepoName  string
	// NoNarrow disables tag narrowing: mutable version refs (v4, v3.1)
	// are kept as the lock comment instead of being resolved to full
	// patch tags (v4.2.1). Bare-SHA reverse lookup still applies.
	NoNarrow bool

	// AcceptMoved treats ref-moved and unreachable-pin findings as
	// resolvable: affected deps are pruned from the inventory and
	// re-resolved to their current live SHA.
	AcceptMoved bool

	// Relock treats ref-moved findings (a branch or partial-version ref
	// that legitimately advanced) as resolvable, re-pinning them to the
	// current live SHA. Unlike AcceptMoved it leaves unreachable-pin
	// findings untouched so possible tampering stays a hard error.
	Relock bool

	// PartialScan reports that explicit workflow paths, rather than the full
	// workflow directory, define this run's mutation authority.
	PartialScan bool

	// OnProgress is called at each phase boundary with a human-readable
	// label (e.g. "Resolving actions/checkout"). Nil means no progress.
	OnProgress func(phase string)
	// contains filtered or unexported fields
}

type Record struct {
	Entries   []Entry
	Workflows []WorkflowPlan
	// EntryRepairs re-record entries the workflows reach only through
	// another entry's `uses:`; see planEntryRepairs.
	EntryRepairs []EntryRepair
}

type Resolution string

type WorkflowPlan struct {
	Path     string
	Rewrites map[string]string
	// RequiredRewrites move redirected `uses:` to the canonical repository;
	// Commit fails rather than skip one.
	RequiredRewrites map[string]string
	// RewrittenIn lists, per RequiredRewrites key, the files Commit found it in.
	RewrittenIn map[string][]string
	// SelfActionFiles are in-repo action definition files reached from this
	// workflow through `$/…`. The same rewrites apply to their `uses:` lines.
	SelfActionFiles []string
}