class Git::Commands::Branch::Move

Implements the ‘git branch –move` command for renaming branches

This command moves/renames a branch, together with its config and reflog. If the old branch name is omitted, renames the current branch.

@example Rename the current branch

move = Git::Commands::Branch::Move.new(execution_context)
move.call('new-branch-name')

@example Rename a specific branch

move = Git::Commands::Branch::Move.new(execution_context)
move.call('old-branch-name', 'new-branch-name')

@example Force rename (overwrite existing branch)

move = Git::Commands::Branch::Move.new(execution_context)
move.call('old-branch', 'existing-branch', force: true)

@note ‘arguments` block audited against git-scm.com/docs/git-branch/2.53.0

@see Git::Commands::Branch

@see git-scm.com/docs/git-branch git-branch

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/branch/move.rb, line 96
def call(*, **)
  super
end

Executes the git branch –move command to rename a branch

@overload call(new_branch, **options)

Rename the current branch to new_branch

@param new_branch [String] the new name for the branch

@param options [Hash] command options

@option options [Boolean, nil] :force (nil) allow renaming even if new_branch already
  exists

  Alias: :f

@return [Git::CommandLine::Result] the result of calling `git branch --move`

@raise [ArgumentError] if unsupported options are provided

@raise [Git::FailedError] if git exits with a non-zero exit status

@api public

@overload call(old_branch, new_branch, **options)

Rename old_branch to new_branch

@param old_branch [String] the current name of the branch

@param new_branch [String] the new name for the branch

@param options [Hash] command options

@option options [Boolean, nil] :force (nil) allow renaming even if new_branch already
  exists

  Alias: :f

@return [Git::CommandLine::Result] the result of calling `git branch --move`

@raise [ArgumentError] if unsupported options are provided

@raise [Git::FailedError] if git exits with a non-zero exit status

@api public

Calls superclass method Git::Commands::Base::call