1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
use anyhow::{Result, bail};
use clap::ArgAction;
use crate::cli::{PushMode, UpdateRefsMode};
use crate::commands::Run;
use crate::commands::cleanup::{cleanup_branch_deletion, cleanup_merged_branch};
use crate::providers::{ReviewState, detect_review_provider};
use crate::settings;
use crate::style;
use crate::{git, stack};
/// Sync the stack with remote state: fetch the trunk, refresh metadata from
/// reviews, clean up merged branches, then restack and push.
#[derive(Debug, clap::Args)]
pub struct Sync {
/// Print what would change without changing anything.
#[arg(long, short = 'n', action = ArgAction::SetTrue)]
dry_run: bool,
/// Force-push (with lease) rebased branches after the restack.
#[arg(long, action = ArgAction::SetTrue, conflicts_with = "no_push")]
push: bool,
/// Do not push rebased branches, overriding stk.pushOnRestack.
#[arg(long, action = ArgAction::SetTrue)]
no_push: bool,
}
impl Run for Sync {
fn run(self) -> Result<()> {
sync(self.dry_run, PushMode::from_flags(self.push, self.no_push))
}
}
pub(crate) fn sync(dry_run: bool, push_mode: PushMode) -> Result<()> {
let current = git::current_branch()?;
let local_branches = git::local_branches()?;
let trunk = stack::trunk_branch(&local_branches);
// Snapshot before the fetch/cleanup/restack rewrites anything. (When
// `merge` calls sync, merge has already snapshotted; this no-ops.)
if !dry_run {
stack::snapshot("sync");
}
// 1. Fetch the trunk so merged work is visible locally.
let remote = settings::remote()?;
let has_remote = git::remote_url(&remote)?.is_some();
if let Some(trunk) = &trunk {
if !has_remote {
anstream::println!("no remote {remote}; skipped fetch");
} else if dry_run {
anstream::println!("would fetch {trunk} from {remote}");
} else if current == *trunk {
git::pull_ff_only()?;
} else {
git::fetch_branch(&remote, trunk)?;
}
}
// 2. The stack containing the current branch (the trunk itself has no
// review and is never synced).
let root = stack::stack_root(¤t)?;
let branches = stack::current_stack_branches(¤t)?;
let (provider, review_provider) = match detect_review_provider() {
Ok(pair) => pair,
// A bare local repo - no remote and no provider configured (the demo
// provider sets one, so it isn't this case) - has no review state to
// sync against, so there is nothing to do rather than an error. A
// remote that exists but isn't recognized is a real config error and
// still surfaces.
Err(_) if !has_remote => {
if branches.is_empty() {
anstream::println!("no stacked branches to sync");
} else {
anstream::println!("no remote configured - nothing to sync");
anstream::println!(
"{}",
style::dim("run `git stk restack` to refresh local branches")
);
}
return Ok(());
}
Err(error) => return Err(error),
};
// 3. Classify every branch: refresh metadata from open reviews, collect
// merged ones for cleanup.
let mut merged = Vec::new();
let mut synced = 0;
let mut skipped = 0;
for branch in &branches {
// Closed-inclusive so a review closed without merging gets a
// truthful skip instead of "no review found".
let Some(review) = review_provider.review_for_branch_including_closed(branch)? else {
anstream::println!(
"{}",
style::dim(&format!(
"skipped {branch}: no {} review found",
provider.kind
))
);
skipped += 1;
continue;
};
if review.branch != *branch {
anstream::println!(
"{}",
style::dim(&format!(
"skipped {branch}: {} review belongs to {}",
provider.kind, review.branch
))
);
skipped += 1;
continue;
}
if review.state == ReviewState::Merged {
anstream::println!(
"{}: review {} is {}",
style::branch(branch),
review.id,
style::state(&review.state)
);
merged.push(branch.clone());
continue;
}
// A closed review's base is dead state: surface it, but never let
// it drive the stack metadata.
if review.state == ReviewState::Closed {
anstream::println!(
"{}",
style::dim(&format!(
"skipped {branch}: review {} was closed without merging",
review.id
))
);
skipped += 1;
continue;
}
// If this branch's parent merged in this same sync, leave its retarget
// to cleanup_merged_branch (step 6): it pins the fork point off the
// merged parent so the restack drops squash-merged commits instead of
// replaying them. Recording a base off the new parent here would lose
// that fork point - the provider may have already retargeted the review
// to the trunk (GitLab does this when the parent branch is deleted).
if let Some(parent) = stack::parent_of(branch)?
&& merged.contains(&parent)
{
continue;
}
if review.branch == review.base {
bail!("refusing to set {branch} as its own stack parent");
}
if !dry_run {
stack::set_parent(branch, &review.base)?;
stack::record_base(branch, &review.base);
}
anstream::println!(
"{} {} -> {} {}",
if dry_run { "would sync" } else { "synced" },
style::branch(&review.branch),
style::branch(&review.base),
style::dim(&format!("({})", review.id))
);
synced += 1;
}
anstream::println!(
"{}",
style::success(&format!(
"sync complete: {synced} {}synced, {skipped} skipped",
if dry_run { "would be " } else { "" }
))
);
// 4. Refresh the stack overview ledger in every review body while the
// merged branches and their reviews are still resolvable, so their
// entries get restyled rather than dropped.
let branch_parents = stack::branch_parents(&branches)?;
crate::notes::update_stack_notes(review_provider.as_ref(), &branch_parents, dry_run, false)?;
let survivors: Vec<String> = branches
.iter()
.filter(|branch| !merged.contains(branch))
.cloned()
.collect();
// 5. Move off any branch that is about to be deleted, onto the first
// survivor (the new stack bottom) or the trunk.
let mut position = current.clone();
if merged.contains(¤t) {
let target = survivors
.first()
.cloned()
.or_else(|| trunk.clone())
.unwrap_or(root.clone());
if dry_run {
anstream::println!("would switch to {}", style::branch(&target));
} else {
git::checkout(&target)?;
}
position = target;
}
// 6. Clean up the merged branches: retarget children, then delete.
for branch in &merged {
cleanup_merged_branch(review_provider.as_ref(), branch, dry_run)?;
cleanup_branch_deletion(branch, &position, dry_run, true)?;
}
// 7. Restack the remainder (and push, per flags/config).
if dry_run {
anstream::println!("would restack the remaining stack");
} else if !survivors.is_empty() {
stack::restack(UpdateRefsMode::Config, push_mode, false)?;
}
// 8. Where to look next.
match survivors.first() {
Some(bottom) => match review_provider.review_for_branch(bottom)? {
Some(review) => anstream::println!(
"next up: {} -> {} {}",
style::branch(bottom),
review.id,
style::dim(&review.url)
),
None => anstream::println!(
"next up: {} {}",
style::branch(bottom),
style::dim("(no review yet)")
),
},
None => {
let base = trunk.unwrap_or(root);
anstream::println!(
"{}",
style::success(&format!("stack complete: everything merged into {base}"))
);
}
}
Ok(())
}