class Git::Commands::Branch::Create

‘git branch` command for creating new branches

This command creates a new branch head pointing to the current HEAD or a specified start point.

@example Basic branch creation

create = Git::Commands::Branch::Create.new(execution_context)
create.call('feature-branch')

@example Create branch from a specific start point

create = Git::Commands::Branch::Create.new(execution_context)
create.call('feature-branch', 'main')

@example Force create (reset existing branch)

create = Git::Commands::Branch::Create.new(execution_context)
create.call('feature-branch', 'main', force: true)

@example Create with upstream tracking

create = Git::Commands::Branch::Create.new(execution_context)
create.call('feature-branch', 'origin/main', track: true)

@example Create without upstream tracking

create = Git::Commands::Branch::Create.new(execution_context)
create.call('feature-branch', 'origin/main', no_track: true)

@example Create with inherited tracking configuration

create = Git::Commands::Branch::Create.new(execution_context)
create.call('feature-branch', 'origin/main', track: 'inherit')

@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/create.rb, line 171
def call(*, **)
  super
end

@overload call(branch_name, **options)

Create a new branch from the current HEAD

@param branch_name [String] the name of the branch to create

@param options [Hash] command options

@option options [Boolean, String, nil] :track (nil) configure upstream tracking for
  the new branch

  - `true`: Set up tracking using the start-point branch itself (`--track`)
  - `'direct'`: Same as `true`, explicitly use start-point as upstream (`--track=direct`)
  - `'inherit'`: Copy upstream configuration from start-point branch (`--track=inherit`)

  Alias: :t

@option options [Boolean, nil] :no_track (nil) do not set up tracking even if
  `branch.autoSetupMerge` is set (`--no-track`)

@option options [Boolean, nil] :force (nil) reset the branch to start point even if
  it already exists

  Without this, git branch refuses to change an existing branch

  Alias: :f

@option options [Boolean, nil] :recurse_submodules (nil) create the branch in the
  superproject and all submodules

  This is an experimental feature

@option options [Boolean, nil] :quiet (nil) suppress informational messages

  Alias: :q

@option options [Boolean, nil] :create_reflog (nil) create the branch's reflog
  (`--create-reflog`)

  Enables date-based sha1 expressions such as `branch@\\{yesterday}`
  In non-bare repositories, reflogs are usually enabled by default via
  `core.logAllRefUpdates`

@option options [Boolean, nil] :no_create_reflog (nil) forcibly disable the
  branch's reflog (`--no-create-reflog`)

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

@raise [ArgumentError] if unsupported options are provided

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

@api public

@overload call(branch_name, start_point, **options)

Create a new branch from the specified start point

@param branch_name [String] the name of the branch to create

@param start_point [String, nil] the commit, branch, or tag to
  start the new branch from

  Can also use `<rev-A>...<rev-B>` syntax for merge base

@param options [Hash] command options

@option options [Boolean, String, nil] :track (nil) configure upstream tracking for
  the new branch

  - `true`: Set up tracking using the start-point branch itself (`--track`)
  - `'direct'`: Same as `true`, explicitly use start-point as upstream (`--track=direct`)
  - `'inherit'`: Copy upstream configuration from start-point branch (`--track=inherit`)

  Alias: :t

@option options [Boolean, nil] :no_track (nil) do not set up tracking even if
  `branch.autoSetupMerge` is set (`--no-track`)

@option options [Boolean, nil] :force (nil) reset the branch to start point even if
  it already exists

  Without this, git branch refuses to change an existing branch

  Alias: :f

@option options [Boolean, nil] :recurse_submodules (nil) create the branch in the
  superproject and all submodules

  This is an experimental feature

@option options [Boolean, nil] :quiet (nil) suppress informational messages

  Alias: :q

@option options [Boolean, nil] :create_reflog (nil) create the branch's reflog
  (`--create-reflog`)

  Enables date-based sha1 expressions such as `branch@\\{yesterday}`
  In non-bare repositories, reflogs are usually enabled by default via
  `core.logAllRefUpdates`

@option options [Boolean, nil] :no_create_reflog (nil) forcibly disable the
  branch's reflog (`--no-create-reflog`)

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

@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