// Copyright 2020-2023 The Jujutsu Authors//// Licensed under the Apache License, Version 2.0 (the "License");// you may not use this file except in compliance with the License.// You may obtain a copy of the License at//// https://www.apache.org/licenses/LICENSE-2.0//// Unless required by applicable law or agreed to in writing, software// distributed under the License is distributed on an "AS IS" BASIS,// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.// See the License for the specific language governing permissions and// limitations under the License. use std::collections::HashSet;use std::fmt;use std::io;use std::io::Write; use clap::ArgGroup;use itertools::Itertools;use jj_lib::backend::CommitId;use jj_lib::git;use jj_lib::git::GitBranchPushTargets;use jj_lib::git::GitPushError;use jj_lib::object_id::ObjectId;use jj_lib::op_store::RefTarget;use jj_lib::refs::classify_bookmark_push_action;use jj_lib::refs::BookmarkPushAction;use jj_lib::refs::BookmarkPushUpdate;use jj_lib::refs::LocalAndRemoteRef;use jj_lib::repo::Repo;use jj_lib::revset::RevsetExpression;use jj_lib::settings::ConfigResultExt as _;use jj_lib::settings::UserSettings;use jj_lib::str_util::StringPattern;use jj_lib::view::View; use crate::cli_util::short_change_hash;use crate::cli_util::short_commit_hash;use crate::cli_util::CommandHelper;use crate::cli_util::RevisionArg;use crate::cli_util::WorkspaceCommandHelper;use crate::cli_util::WorkspaceCommandTransaction;use crate::command_error::user_error;use crate::command_error::user_error_with_hint;use crate::command_error::CommandError;use crate::commands::git::get_single_remote;use crate::formatter::Formatter;use crate::git_util::get_git_repo;use crate::git_util::map_git_error;use crate::git_util::with_remote_git_callbacks;use crate::git_util::GitSidebandProgressMessageWriter;use crate::ui::Ui; /// Push to a Git remote////// By default, pushes any bookmarks pointing to/// `remote_bookmarks(remote=<remote>)..@`. Use `--bookmark` to push specific/// bookmarks. Use `--all` to push all bookmarks. Use `--change` to generate/// bookmark names based on the change IDs of specific commits.////// Before the command actually moves, creates, or deletes a remote bookmark, it/// makes several [safety checks]. If there is a problem, you may need to run/// `jj git fetch --remote <remote name>` and/or resolve some [bookmark/// conflicts].////// [safety checks]:/// https://martinvonz.github.io/jj/latest/bookmarks/#pushing-bookmarks-safety-checks////// [bookmark conflicts]:/// https://martinvonz.github.io/jj/latest/bookmarks/#conflicts #[derive(clap::Args, Clone, Debug)]#[command(group(ArgGroup::new("specific").args(&["bookmark", "change", "revisions"]).multiple(true)))]#[command(group(ArgGroup::new("what").args(&["all", "deleted", "tracked"]).conflicts_with("specific")))]pub struct GitPushArgs { /// The remote to push to (only named remotes are supported) #[arg(long)] remote: Option<String>, /// Push only this bookmark, or bookmarks matching a pattern (can be /// repeated) /// /// By default, the specified name matches exactly. Use `glob:` prefix to /// select bookmarks by wildcard pattern. For details, see /// https://martinvonz.github.io/jj/latest/revsets#string-patterns. #[arg(long, short, alias="branch", value_parser = StringPattern::parse)] bookmark: Vec<StringPattern>, /// Push all bookmarks (including deleted bookmarks) #[arg(long)] all: bool, /// Push all tracked bookmarks (including deleted bookmarks) /// /// This usually means that the bookmark was already pushed to or fetched /// from the relevant remote. For details, see /// https://martinvonz.github.io/jj/latest/bookmarks#remotes-and-tracked-bookmarks #[arg(long)] tracked: bool, /// Push all deleted bookmarks /// /// Only tracked bookmarks can be successfully deleted on the remote. A /// warning will be printed if any untracked bookmarks on the remote /// correspond to missing local bookmarks. #[arg(long)] deleted: bool, /// Allow pushing commits with empty descriptions #[arg(long)] allow_empty_description: bool, /// Allow pushing commits that are private #[arg(long)] allow_private: bool, /// Push bookmarks pointing to these commits (can be repeated) #[arg(long, short)] revisions: Vec<RevisionArg>, /// Push this commit by creating a bookmark based on its change ID (can be /// repeated) /// /// Use the `git.push-bookmark-prefix` setting to change the prefix for /// generated names. #[arg(long, short)] change: Vec<RevisionArg>, /// Only display what will change on the remote #[arg(long)] dry_run: bool,} fn make_bookmark_term(bookmark_names: &[impl fmt::Display]) -> String { match bookmark_names { [bookmark_name] => format!("bookmark {bookmark_name}"), bookmark_names => format!("bookmarks {}", bookmark_names.iter().join(", ")), }} const DEFAULT_REMOTE: &str = "origin"; #[derive(Clone, Copy, Debug, Eq, PartialEq)]enum BookmarkMoveDirection { Forward, Backward, Sideways,} pub fn cmd_git_push( ui: &mut Ui, command: &CommandHelper, args: &GitPushArgs,) -> Result<(), CommandError> { let mut workspace_command = command.workspace_helper(ui)?; let git_repo = get_git_repo(workspace_command.repo().store())?; let remote = if let Some(name) = &args.remote { name.clone() } else { get_default_push_remote(ui, command.settings(), &git_repo)? }; let repo = workspace_command.repo().clone(); let mut tx = workspace_command.start_transaction(); let tx_description; let mut bookmark_updates = vec![]; if args.all { for (bookmark_name, targets) in repo.view().local_remote_bookmarks(&remote) { match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => {} Err(reason) => reason.print(ui)?, } } tx_description = format!("push all bookmarks to git remote {remote}"); } else if args.tracked { for (bookmark_name, targets) in repo.view().local_remote_bookmarks(&remote) { if !targets.remote_ref.is_tracking() { continue; } match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => {} Err(reason) => reason.print(ui)?, } } tx_description = format!("push all tracked bookmarks to git remote {remote}"); } else if args.deleted { for (bookmark_name, targets) in repo.view().local_remote_bookmarks(&remote) { if targets.local_target.is_present() { continue; } match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => {} Err(reason) => reason.print(ui)?, } } tx_description = format!("push all deleted bookmarks to git remote {remote}"); } else { let mut seen_bookmarks: HashSet<&str> = HashSet::new(); // Process --change bookmarks first because matching bookmarks can be moved. // TODO: Drop support support for git.push-branch-prefix in 0.28.0+ let bookmark_prefix = if let Some(prefix) = command.settings().push_branch_prefix() { writeln!( ui.warning_default(), "Config git.push-branch-prefix is deprecated. Please switch to \ git.push-bookmark-prefix", )?; prefix } else { command.settings().push_bookmark_prefix() }; let change_bookmark_names = update_change_bookmarks(ui, &mut tx, &args.change, &bookmark_prefix)?; let change_bookmarks = change_bookmark_names.iter().map(|bookmark_name| { let targets = LocalAndRemoteRef { local_target: tx.repo().view().get_local_bookmark(bookmark_name), remote_ref: tx.repo().view().get_remote_bookmark(bookmark_name, &remote), }; (bookmark_name.as_ref(), targets) }); let bookmarks_by_name = find_bookmarks_to_push(repo.view(), &args.bookmark, &remote)?; for (bookmark_name, targets) in change_bookmarks.chain(bookmarks_by_name.iter().copied()) { if !seen_bookmarks.insert(bookmark_name) { continue; } match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => writeln!( ui.status(), "Bookmark {bookmark_name}@{remote} already matches {bookmark_name}", )?, Err(reason) => return Err(reason.into()), } } let use_default_revset = args.bookmark.is_empty() && args.change.is_empty() && args.revisions.is_empty(); let bookmarks_targeted = find_bookmarks_targeted_by_revisions( ui, tx.base_workspace_helper(), &remote, &args.revisions, use_default_revset, )?; for &(bookmark_name, targets) in &bookmarks_targeted { if !seen_bookmarks.insert(bookmark_name) { continue; } match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => {} Err(reason) => reason.print(ui)?, } } tx_description = format!( "push {} to git remote {}", make_bookmark_term( &bookmark_updates .iter() .map(|(bookmark, _)| bookmark.as_str()) .collect_vec() ), &remote ); } if bookmark_updates.is_empty() { writeln!(ui.status(), "Nothing changed.")?; return Ok(()); } validate_commits_ready_to_push(ui, &bookmark_updates, &remote, &tx, command, args)?; if let Some(mut formatter) = ui.status_formatter() { writeln!(formatter, "Changes to push to {remote}:")?; print_commits_ready_to_push(formatter.as_mut(), repo.as_ref(), &bookmark_updates)?; } if args.dry_run { writeln!(ui.status(), "Dry-run requested, not pushing.")?; return Ok(()); } let targets = GitBranchPushTargets { branch_updates: bookmark_updates, }; let mut writer = GitSidebandProgressMessageWriter::new(ui); let mut sideband_progress_callback = |progress_message: &[u8]| { _ = writer.write(ui, progress_message); }; with_remote_git_callbacks(ui, Some(&mut sideband_progress_callback), |cb| { git::push_branches(tx.repo_mut(), &git_repo, &remote, &targets, cb) }) .map_err(|err| match err { GitPushError::InternalGitError(err) => map_git_error(err), GitPushError::RefInUnexpectedLocation(refs) => user_error_with_hint( format!( "Refusing to push a bookmark that unexpectedly moved on the remote. Affected \ refs: {}", refs.join(", ") ), "Try fetching from the remote, then make the bookmark point to where you want it to \ be, and push again.", ), _ => user_error(err), })?; writer.flush(ui)?; tx.finish(ui, tx_description)?; Ok(())} /// Validates that the commits that will be pushed are ready (have authorship/// information, are not conflicted, etc.)fn validate_commits_ready_to_push( ui: &Ui, bookmark_updates: &[(String, BookmarkPushUpdate)], remote: &str, tx: &WorkspaceCommandTransaction, command: &CommandHelper, args: &GitPushArgs,) -> Result<(), CommandError> { let workspace_helper = tx.base_workspace_helper(); let repo = workspace_helper.repo(); let new_heads = bookmark_updates .iter() .filter_map(|(_, update)| update.new_target.clone()) .collect_vec(); let old_heads = repo .view() .remote_bookmarks(remote) .flat_map(|(_, old_head)| old_head.target.added_ids()) .cloned() .collect_vec(); let commits_to_push = RevsetExpression::commits(old_heads) .union(workspace_helper.env().immutable_heads_expression()) .range(&RevsetExpression::commits(new_heads)); let config = command.settings().config(); let is_private = if let Ok(revset) = config.get_string("git.private-commits") { workspace_helper .parse_revset(ui, &RevisionArg::from(revset))? .evaluate()? .containing_fn() } else { Box::new(|_: &CommitId| Ok(false)) }; for commit in workspace_helper .attach_revset_evaluator(commits_to_push) .evaluate_to_commits()? { let commit = commit?; let mut reasons = vec![]; if commit.description().is_empty() && !args.allow_empty_description { reasons.push("it has no description"); } if commit.author().name.is_empty() || commit.author().name == UserSettings::USER_NAME_PLACEHOLDER || commit.author().email.is_empty() || commit.author().email == UserSettings::USER_EMAIL_PLACEHOLDER || commit.committer().name.is_empty() || commit.committer().name == UserSettings::USER_NAME_PLACEHOLDER || commit.committer().email.is_empty() || commit.committer().email == UserSettings::USER_EMAIL_PLACEHOLDER { reasons.push("it has no author and/or committer set"); } if commit.has_conflict()? { reasons.push("it has conflicts"); } if !args.allow_private && is_private(commit.id())? { reasons.push("it is private"); } if !reasons.is_empty() { return Err(user_error(format!( "Won't push commit {} since {}", short_commit_hash(commit.id()), reasons.join(" and ") ))); } } Ok(())} fn print_commits_ready_to_push( formatter: &mut dyn Formatter, repo: &dyn Repo, bookmark_updates: &[(String, BookmarkPushUpdate)],) -> io::Result<()> { let to_direction = |old_target: &CommitId, new_target: &CommitId| { assert_ne!(old_target, new_target); if repo.index().is_ancestor(old_target, new_target) { BookmarkMoveDirection::Forward } else if repo.index().is_ancestor(new_target, old_target) { BookmarkMoveDirection::Backward } else { BookmarkMoveDirection::Sideways } }; for (bookmark_name, update) in bookmark_updates { match (&update.old_target, &update.new_target) { (Some(old_target), Some(new_target)) => { let old = short_commit_hash(old_target); let new = short_commit_hash(new_target); // TODO(ilyagr): Add color. Once there is color, "Move bookmark ... sideways" // may read more naturally than "Move sideways bookmark ...". // Without color, it's hard to see at a glance if one bookmark // among many was moved sideways (say). TODO: People on Discord // suggest "Move bookmark ... forward by n commits", // possibly "Move bookmark ... sideways (X forward, Y back)". let msg = match to_direction(old_target, new_target) { BookmarkMoveDirection::Forward => { format!("Move forward bookmark {bookmark_name} from {old} to {new}") } BookmarkMoveDirection::Backward => { format!("Move backward bookmark {bookmark_name} from {old} to {new}") } BookmarkMoveDirection::Sideways => { format!("Move sideways bookmark {bookmark_name} from {old} to {new}") } }; writeln!(formatter, " {msg}")?; } (Some(old_target), None) => { writeln!( formatter, " Delete bookmark {bookmark_name} from {}", short_commit_hash(old_target) )?; } (None, Some(new_target)) => { writeln!( formatter, " Add bookmark {bookmark_name} to {}", short_commit_hash(new_target) )?; } (None, None) => { panic!("Not pushing any change to bookmark {bookmark_name}"); } } } Ok(())} fn get_default_push_remote( ui: &Ui, settings: &UserSettings, git_repo: &git2::Repository,) -> Result<String, CommandError> { if let Some(remote) = settings.config().get_string("git.push").optional()? { Ok(remote) } else if let Some(remote) = get_single_remote(git_repo)? { // similar to get_default_fetch_remotes if remote != DEFAULT_REMOTE { writeln!( ui.hint_default(), "Pushing to the only existing remote: {remote}" )?; } Ok(remote) } else { Ok(DEFAULT_REMOTE.to_owned()) }} #[derive(Clone, Debug)]struct RejectedBookmarkUpdateReason { message: String, hint: Option<String>,} impl RejectedBookmarkUpdateReason { fn print(&self, ui: &Ui) -> io::Result<()> { writeln!(ui.warning_default(), "{}", self.message)?; if let Some(hint) = &self.hint { writeln!(ui.hint_default(), "{hint}")?; } Ok(()) }} impl From<RejectedBookmarkUpdateReason> for CommandError { fn from(reason: RejectedBookmarkUpdateReason) -> Self { let RejectedBookmarkUpdateReason { message, hint } = reason; let mut cmd_err = user_error(message); cmd_err.extend_hints(hint); cmd_err }} fn classify_bookmark_update( bookmark_name: &str, remote_name: &str, targets: LocalAndRemoteRef,) -> Result<Option<BookmarkPushUpdate>, RejectedBookmarkUpdateReason> { let push_action = classify_bookmark_push_action(targets); match push_action { BookmarkPushAction::AlreadyMatches => Ok(None), BookmarkPushAction::LocalConflicted => Err(RejectedBookmarkUpdateReason { message: format!("Bookmark {bookmark_name} is conflicted"), hint: Some(Lines 1–500 of 654. Load more
// Copyright 2020-2023 The Jujutsu Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use std::collections::HashSet; use std::fmt; use std::io; use std::io::Write; use clap::ArgGroup; use itertools::Itertools; use jj_lib::backend::CommitId; use jj_lib::git; use jj_lib::git::GitBranchPushTargets; use jj_lib::git::GitPushError; use jj_lib::object_id::ObjectId; use jj_lib::op_store::RefTarget; use jj_lib::refs::classify_bookmark_push_action; use jj_lib::refs::BookmarkPushAction; use jj_lib::refs::BookmarkPushUpdate; use jj_lib::refs::LocalAndRemoteRef; use jj_lib::repo::Repo; use jj_lib::revset::RevsetExpression; use jj_lib::settings::ConfigResultExt as _; use jj_lib::settings::UserSettings; use jj_lib::str_util::StringPattern; use jj_lib::view::View; use crate::cli_util::short_change_hash; use crate::cli_util::short_commit_hash; use crate::cli_util::CommandHelper; use crate::cli_util::RevisionArg; use crate::cli_util::WorkspaceCommandHelper; use crate::cli_util::WorkspaceCommandTransaction; use crate::command_error::user_error; use crate::command_error::user_error_with_hint; use crate::command_error::CommandError; use crate::commands::git::get_single_remote; use crate::formatter::Formatter; use crate::git_util::get_git_repo; use crate::git_util::map_git_error; use crate::git_util::with_remote_git_callbacks; use crate::git_util::GitSidebandProgressMessageWriter; use crate::ui::Ui; /// Push to a Git remote /// /// By default, pushes any bookmarks pointing to /// `remote_bookmarks(remote=<remote>)..@`. Use `--bookmark` to push specific /// bookmarks. Use `--all` to push all bookmarks. Use `--change` to generate /// bookmark names based on the change IDs of specific commits. /// /// Before the command actually moves, creates, or deletes a remote bookmark, it /// makes several [safety checks]. If there is a problem, you may need to run /// `jj git fetch --remote <remote name>` and/or resolve some [bookmark /// conflicts]. /// /// [safety checks]: /// https://martinvonz.github.io/jj/latest/bookmarks/#pushing-bookmarks-safety-checks /// /// [bookmark conflicts]: /// https://martinvonz.github.io/jj/latest/bookmarks/#conflicts #[derive(clap::Args, Clone, Debug)] #[command(group(ArgGroup::new("specific").args(&["bookmark", "change", "revisions"]).multiple(true)))] #[command(group(ArgGroup::new("what").args(&["all", "deleted", "tracked"]).conflicts_with("specific")))] pub struct GitPushArgs { /// The remote to push to (only named remotes are supported) #[arg(long)] remote: Option<String>, /// Push only this bookmark, or bookmarks matching a pattern (can be /// repeated) /// /// By default, the specified name matches exactly. Use `glob:` prefix to /// select bookmarks by wildcard pattern. For details, see /// https://martinvonz.github.io/jj/latest/revsets#string-patterns. #[arg(long, short, alias="branch", value_parser = StringPattern::parse)] bookmark: Vec<StringPattern>, /// Push all bookmarks (including deleted bookmarks) #[arg(long)] all: bool, /// Push all tracked bookmarks (including deleted bookmarks) /// /// This usually means that the bookmark was already pushed to or fetched /// from the relevant remote. For details, see /// https://martinvonz.github.io/jj/latest/bookmarks#remotes-and-tracked-bookmarks #[arg(long)] tracked: bool, /// Push all deleted bookmarks /// /// Only tracked bookmarks can be successfully deleted on the remote. A /// warning will be printed if any untracked bookmarks on the remote /// correspond to missing local bookmarks. #[arg(long)] deleted: bool, /// Allow pushing commits with empty descriptions #[arg(long)] allow_empty_description: bool, /// Allow pushing commits that are private #[arg(long)] allow_private: bool, /// Push bookmarks pointing to these commits (can be repeated) #[arg(long, short)] revisions: Vec<RevisionArg>, /// Push this commit by creating a bookmark based on its change ID (can be /// repeated) /// /// Use the `git.push-bookmark-prefix` setting to change the prefix for /// generated names. #[arg(long, short)] change: Vec<RevisionArg>, /// Only display what will change on the remote #[arg(long)] dry_run: bool, } fn make_bookmark_term(bookmark_names: &[impl fmt::Display]) -> String { match bookmark_names { [bookmark_name] => format!("bookmark {bookmark_name}"), bookmark_names => format!("bookmarks {}", bookmark_names.iter().join(", ")), } } const DEFAULT_REMOTE: &str = "origin"; #[derive(Clone, Copy, Debug, Eq, PartialEq)] enum BookmarkMoveDirection { Forward, Backward, Sideways, } pub fn cmd_git_push( ui: &mut Ui, command: &CommandHelper, args: &GitPushArgs, ) -> Result<(), CommandError> { let mut workspace_command = command.workspace_helper(ui)?; let git_repo = get_git_repo(workspace_command.repo().store())?; let remote = if let Some(name) = &args.remote { name.clone() } else { get_default_push_remote(ui, command.settings(), &git_repo)? }; let repo = workspace_command.repo().clone(); let mut tx = workspace_command.start_transaction(); let tx_description; let mut bookmark_updates = vec![]; if args.all { for (bookmark_name, targets) in repo.view().local_remote_bookmarks(&remote) { match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => {} Err(reason) => reason.print(ui)?, } } tx_description = format!("push all bookmarks to git remote {remote}"); } else if args.tracked { for (bookmark_name, targets) in repo.view().local_remote_bookmarks(&remote) { if !targets.remote_ref.is_tracking() { continue; } match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => {} Err(reason) => reason.print(ui)?, } } tx_description = format!("push all tracked bookmarks to git remote {remote}"); } else if args.deleted { for (bookmark_name, targets) in repo.view().local_remote_bookmarks(&remote) { if targets.local_target.is_present() { continue; } match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => {} Err(reason) => reason.print(ui)?, } } tx_description = format!("push all deleted bookmarks to git remote {remote}"); } else { let mut seen_bookmarks: HashSet<&str> = HashSet::new(); // Process --change bookmarks first because matching bookmarks can be moved. // TODO: Drop support support for git.push-branch-prefix in 0.28.0+ let bookmark_prefix = if let Some(prefix) = command.settings().push_branch_prefix() { writeln!( ui.warning_default(), "Config git.push-branch-prefix is deprecated. Please switch to \ git.push-bookmark-prefix", )?; prefix } else { command.settings().push_bookmark_prefix() }; let change_bookmark_names = update_change_bookmarks(ui, &mut tx, &args.change, &bookmark_prefix)?; let change_bookmarks = change_bookmark_names.iter().map(|bookmark_name| { let targets = LocalAndRemoteRef { local_target: tx.repo().view().get_local_bookmark(bookmark_name), remote_ref: tx.repo().view().get_remote_bookmark(bookmark_name, &remote), }; (bookmark_name.as_ref(), targets) }); let bookmarks_by_name = find_bookmarks_to_push(repo.view(), &args.bookmark, &remote)?; for (bookmark_name, targets) in change_bookmarks.chain(bookmarks_by_name.iter().copied()) { if !seen_bookmarks.insert(bookmark_name) { continue; } match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => writeln!( ui.status(), "Bookmark {bookmark_name}@{remote} already matches {bookmark_name}", )?, Err(reason) => return Err(reason.into()), } } let use_default_revset = args.bookmark.is_empty() && args.change.is_empty() && args.revisions.is_empty(); let bookmarks_targeted = find_bookmarks_targeted_by_revisions( ui, tx.base_workspace_helper(), &remote, &args.revisions, use_default_revset, )?; for &(bookmark_name, targets) in &bookmarks_targeted { if !seen_bookmarks.insert(bookmark_name) { continue; } match classify_bookmark_update(bookmark_name, &remote, targets) { Ok(Some(update)) => bookmark_updates.push((bookmark_name.to_owned(), update)), Ok(None) => {} Err(reason) => reason.print(ui)?, } } tx_description = format!( "push {} to git remote {}", make_bookmark_term( &bookmark_updates .iter() .map(|(bookmark, _)| bookmark.as_str()) .collect_vec() ), &remote ); } if bookmark_updates.is_empty() { writeln!(ui.status(), "Nothing changed.")?; return Ok(()); } validate_commits_ready_to_push(ui, &bookmark_updates, &remote, &tx, command, args)?; if let Some(mut formatter) = ui.status_formatter() { writeln!(formatter, "Changes to push to {remote}:")?; print_commits_ready_to_push(formatter.as_mut(), repo.as_ref(), &bookmark_updates)?; } if args.dry_run { writeln!(ui.status(), "Dry-run requested, not pushing.")?; return Ok(()); } let targets = GitBranchPushTargets { branch_updates: bookmark_updates, }; let mut writer = GitSidebandProgressMessageWriter::new(ui); let mut sideband_progress_callback = |progress_message: &[u8]| { _ = writer.write(ui, progress_message); }; with_remote_git_callbacks(ui, Some(&mut sideband_progress_callback), |cb| { git::push_branches(tx.repo_mut(), &git_repo, &remote, &targets, cb) }) .map_err(|err| match err { GitPushError::InternalGitError(err) => map_git_error(err), GitPushError::RefInUnexpectedLocation(refs) => user_error_with_hint( format!( "Refusing to push a bookmark that unexpectedly moved on the remote. Affected \ refs: {}", refs.join(", ") ), "Try fetching from the remote, then make the bookmark point to where you want it to \ be, and push again.", ), _ => user_error(err), })?; writer.flush(ui)?; tx.finish(ui, tx_description)?; Ok(()) } /// Validates that the commits that will be pushed are ready (have authorship /// information, are not conflicted, etc.) fn validate_commits_ready_to_push( ui: &Ui, bookmark_updates: &[(String, BookmarkPushUpdate)], remote: &str, tx: &WorkspaceCommandTransaction, command: &CommandHelper, args: &GitPushArgs, ) -> Result<(), CommandError> { let workspace_helper = tx.base_workspace_helper(); let repo = workspace_helper.repo(); let new_heads = bookmark_updates .iter() .filter_map(|(_, update)| update.new_target.clone()) .collect_vec(); let old_heads = repo .view() .remote_bookmarks(remote) .flat_map(|(_, old_head)| old_head.target.added_ids()) .cloned() .collect_vec(); let commits_to_push = RevsetExpression::commits(old_heads) .union(workspace_helper.env().immutable_heads_expression()) .range(&RevsetExpression::commits(new_heads)); let config = command.settings().config(); let is_private = if let Ok(revset) = config.get_string("git.private-commits") { workspace_helper .parse_revset(ui, &RevisionArg::from(revset))? .evaluate()? .containing_fn() } else { Box::new(|_: &CommitId| Ok(false)) }; for commit in workspace_helper .attach_revset_evaluator(commits_to_push) .evaluate_to_commits()? { let commit = commit?; let mut reasons = vec![]; if commit.description().is_empty() && !args.allow_empty_description { reasons.push("it has no description"); } if commit.author().name.is_empty() || commit.author().name == UserSettings::USER_NAME_PLACEHOLDER || commit.author().email.is_empty() || commit.author().email == UserSettings::USER_EMAIL_PLACEHOLDER || commit.committer().name.is_empty() || commit.committer().name == UserSettings::USER_NAME_PLACEHOLDER || commit.committer().email.is_empty() || commit.committer().email == UserSettings::USER_EMAIL_PLACEHOLDER { reasons.push("it has no author and/or committer set"); } if commit.has_conflict()? { reasons.push("it has conflicts"); } if !args.allow_private && is_private(commit.id())? { reasons.push("it is private"); } if !reasons.is_empty() { return Err(user_error(format!( "Won't push commit {} since {}", short_commit_hash(commit.id()), reasons.join(" and ") ))); } } Ok(()) } fn print_commits_ready_to_push( formatter: &mut dyn Formatter, repo: &dyn Repo, bookmark_updates: &[(String, BookmarkPushUpdate)], ) -> io::Result<()> { let to_direction = |old_target: &CommitId, new_target: &CommitId| { assert_ne!(old_target, new_target); if repo.index().is_ancestor(old_target, new_target) { BookmarkMoveDirection::Forward } else if repo.index().is_ancestor(new_target, old_target) { BookmarkMoveDirection::Backward } else { BookmarkMoveDirection::Sideways } }; for (bookmark_name, update) in bookmark_updates { match (&update.old_target, &update.new_target) { (Some(old_target), Some(new_target)) => { let old = short_commit_hash(old_target); let new = short_commit_hash(new_target); // TODO(ilyagr): Add color. Once there is color, "Move bookmark ... sideways" // may read more naturally than "Move sideways bookmark ...". // Without color, it's hard to see at a glance if one bookmark // among many was moved sideways (say). TODO: People on Discord // suggest "Move bookmark ... forward by n commits", // possibly "Move bookmark ... sideways (X forward, Y back)". let msg = match to_direction(old_target, new_target) { BookmarkMoveDirection::Forward => { format!("Move forward bookmark {bookmark_name} from {old} to {new}") } BookmarkMoveDirection::Backward => { format!("Move backward bookmark {bookmark_name} from {old} to {new}") } BookmarkMoveDirection::Sideways => { format!("Move sideways bookmark {bookmark_name} from {old} to {new}") } }; writeln!(formatter, " {msg}")?; } (Some(old_target), None) => { writeln!( formatter, " Delete bookmark {bookmark_name} from {}", short_commit_hash(old_target) )?; } (None, Some(new_target)) => { writeln!( formatter, " Add bookmark {bookmark_name} to {}", short_commit_hash(new_target) )?; } (None, None) => { panic!("Not pushing any change to bookmark {bookmark_name}"); } } } Ok(()) } fn get_default_push_remote( ui: &Ui, settings: &UserSettings, git_repo: &git2::Repository, ) -> Result<String, CommandError> { if let Some(remote) = settings.config().get_string("git.push").optional()? { Ok(remote) } else if let Some(remote) = get_single_remote(git_repo)? { // similar to get_default_fetch_remotes if remote != DEFAULT_REMOTE { writeln!( ui.hint_default(), "Pushing to the only existing remote: {remote}" )?; } Ok(remote) } else { Ok(DEFAULT_REMOTE.to_owned()) } } #[derive(Clone, Debug)] struct RejectedBookmarkUpdateReason { message: String, hint: Option<String>, } impl RejectedBookmarkUpdateReason { fn print(&self, ui: &Ui) -> io::Result<()> { writeln!(ui.warning_default(), "{}", self.message)?; if let Some(hint) = &self.hint { writeln!(ui.hint_default(), "{hint}")?; } Ok(()) } } impl From<RejectedBookmarkUpdateReason> for CommandError { fn from(reason: RejectedBookmarkUpdateReason) -> Self { let RejectedBookmarkUpdateReason { message, hint } = reason; let mut cmd_err = user_error(message); cmd_err.extend_hints(hint); cmd_err } } fn classify_bookmark_update( bookmark_name: &str, remote_name: &str, targets: LocalAndRemoteRef, ) -> Result<Option<BookmarkPushUpdate>, RejectedBookmarkUpdateReason> { let push_action = classify_bookmark_push_action(targets); match push_action { BookmarkPushAction::AlreadyMatches => Ok(None), BookmarkPushAction::LocalConflicted => Err(RejectedBookmarkUpdateReason { message: format!("Bookmark {bookmark_name} is conflicted"), hint: Some(