Documentation
¶
Overview ¶
Package fleetsync decides and performs the sync action for a single repo: clone or pull an active repo, or — only when the caller explicitly opts in — remove an archived one's local clone. It has no TUI or terminal output of its own — callers (e.g. the wb sync worker pool) drive it and render results.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Result ¶
type Result struct {
Repo discover.Repo
Status Status
// PullPlanned is true only for a dry-run existing clone. PullAttempted and
// PullSucceeded describe the real action independently of Status, which may
// still end as Unpushed after a successful pull. Updated is a successful
// pull whose checked-out commit moved forward.
PullPlanned bool
PullAttempted bool
PullSucceeded bool
Updated bool
Detail gitops.RepoStatus
// Tracking is filled in only for Diverged and NoUpstream, whose reports
// are meaningless without the branch names and ahead/behind counts.
Tracking gitops.TrackingState
Err error
// Archived mirrors repo.Archived, for callers that render results without
// keeping the original discover.Repo alongside them.
Archived bool
// ArchivedNotPruned is true when Archived is true but the caller did not
// request pruning (Sync's pruneArchived parameter was false): this
// repository was pulled or left alone exactly like any other clone,
// never evaluated for deletion. It exists so an archived repository is
// never silently indistinguishable from an ordinary one in a report —
// the whole point of making pruning opt-in is defeated if turning it off
// also makes archived repositories invisible.
ArchivedNotPruned bool
// Reason explains, in prose, exactly why an archived repository was or
// was not eligible for removal when pruning was requested. It is the
// verbatim explanation from internal/archiveprune.Evaluate — the same
// safety predicate wb archive clean uses — never a re-derived summary.
Reason string
}
Result is the outcome of syncing one repo.
func Sync ¶
func Sync(ctx context.Context, repo discover.Repo, projectsRoot string, dryRun, pruneArchived bool) Result
Sync reconciles a single repo's local clone with its GitHub state: clone if missing, pull if present and clean, skip if the working tree is dirty. Forks and repos not owned by the authenticated user or their orgs (repo.Remote == false) are left untouched (NoOp). Repos marked with `wb repo ignore` are left untouched too (SkippedIgnored), including archived ones. In dryRun mode no mutation happens; Status still reports what would be done.
An archived repository is never deleted unless pruneArchived is true. With pruneArchived false — the default for `wb sync` — an archived repository with a local clone is pulled exactly like any other clone (its Status may be Pulled, SkippedDirty, Unpushed, and so on); one with no local clone yet is reported AbsentArchived, since cloning it here would be an unrequested behavior change and it carries no risk either way. Every archived result still carries Archived and, when not pruning, ArchivedNotPruned, so a report can never make an archived repository indistinguishable from an ordinary one just because pruning was left off.
With pruneArchived true, an archived repository's local clone is removed only when it passes internal/archiveprune.Evaluate — the exact safety predicate `wb archive clean` uses (live-confirmed archived status, no uncommitted/untracked changes, no stash, no unpushed commits on any branch, no local-only branch, no unpushed tag, no linked worktree, no non-terminal WB Work Log claim, not marked wb.skip-sync). That predicate is called verbatim, not re-derived, so this path and `wb archive clean` can never drift into different definitions of "safe to delete".
func (Result) PullSummary ¶ added in v0.55.0
PullSummary renders the pull action independently of the final repository status. Empty means this result did not concern an existing active clone.
type Status ¶
type Status int
Status is the outcome fleetsync.Sync took for a single repo.
const ( Cloned Status = iota Pulled SkippedDirty RemovedArchived KeptArchived AbsentArchived NoOp Failed // SkippedIgnored, EmptyRemote, Diverged and NoUpstream are appended last // deliberately: Status is rendered only through String() and never // persisted numerically, but appending keeps the existing values stable // regardless. SkippedIgnored EmptyRemote // Diverged: the branch and its upstream each hold commits the other // lacks, so no fast-forward is possible and sync must not guess a // reconciliation. Diverged // NoUpstream: the checked-out branch tracks nothing, so there is nowhere // to pull from. NoUpstream // Unpushed: the pull succeeded, but the clone holds commits that exist on // no remote. Nothing is wrong with the sync; the work has simply never // left this machine. Unpushed // ArchivedUnlandable: an archived clone holding unpushed commits. The // remote is read-only, so those commits can never be pushed — unlike // KeptArchived, this state cannot resolve itself and needs a decision. ArchivedUnlandable )
type SummaryGroup ¶ added in v0.56.0
type SummaryGroup struct {
Label string
Section SummarySection
Results []Result
}
SummaryGroup is one selectable/countable row in the final sync summary. Results are sorted by repository slug so every renderer is deterministic. A result may belong to both an action row and a final-outcome row.
func Summary ¶ added in v0.56.0
func Summary(results []Result) []SummaryGroup
Summary builds the ordered category model shared by plain output and the interactive results browser.
func SummaryGroupByLabel ¶ added in v0.56.0
func SummaryGroupByLabel(groups []SummaryGroup, label string) (SummaryGroup, bool)
SummaryGroupByLabel finds a summary row by its stable display label.
type SummarySection ¶ added in v0.56.0
type SummarySection string
SummarySection groups related rows in both the plain and interactive sync summaries. Its value is the human-readable section heading.
const ( SummaryFinalOutcomes SummarySection = "Final outcomes" SummaryPullActions SummarySection = "Pull actions" SummaryAttention SummarySection = "Attention" SummaryErrors SummarySection = "Failures" )
Source Files