Method: Git::Base#pull

Defined in:
lib/git/base.rb

#pull(remote = nil, branch = nil, opts = {}) ⇒ Void

Pulls the given branch from the given remote into the current branch

Examples:

pulls from origin/master

@git.pull

pulls from upstream/master

@git.pull('upstream')

pulls from upstream/develop

@git.pull('upstream', 'develop')

Parameters:

  • remote (String) (defaults to: nil)

    the remote repository to pull from

  • branch (String) (defaults to: nil)

    the branch to pull from

  • opts (Hash) (defaults to: {})

    options to pass to the pull command

Options Hash (opts):

  • :allow_unrelated_histories (Boolean) — default: false

    Merges histories of two projects that started their lives independently

Returns:

  • (Void)

Raises:

  • (Git::FailedError)

    if the pull fails

  • (ArgumentError)

    if a branch is given without a remote

[View source]

497
498
499
# File 'lib/git/base.rb', line 497

def pull(remote = nil, branch = nil, opts = {})
  self.lib.pull(remote, branch, opts)
end