Method: Git::Base.repository_default_branch

Defined in:

lib/git/base.rb

.repository_default_branch(repository, options = {}) ⇒ String

Returns the name of the default branch of the given repository

Examples:

with a URI string

Git.default_branch('https://github.com/ruby-git/ruby-git') # => 'master'
Git.default_branch('https://github.com/rspec/rspec-core') # => 'main'

with a URI object

repository_uri = URI('https://github.com/ruby-git/ruby-git')
Git.default_branch(repository_uri) # => 'master'

with a local repository

Git.default_branch('.') # => 'master'

with a local repository Pathname

repository_path = Pathname('.')
Git.default_branch(repository_path) # => 'master'

with the logging option

logger = Logger.new(STDOUT, level: Logger::INFO)
Git.default_branch('.', log: logger) # => 'master'
I, [2022-04-13T16:01:33.221596 #18415]  INFO -- : git '-c' 'core.quotePath=true' '-c' 'color.ui=false' ls-remote '--symref' '--' '.' 'HEAD'  2>&1

Parameters:

• repository (URI, Pathname, String) —

  The (possibly remote) repository to get the default branch name for

  See GIT URLS for more information.

• options (Hash) (defaults to: {}) —

  The options for this command (see list of valid options below)

Options Hash (options):

• :log (Logger) —

  A logger to use for Git operations. Git commands are logged at the :info level. Additional logging is done at the :debug level.

Returns:

• (String) —

  the name of the default branch

# File 'lib/git/base.rb', line 30

def self.repository_default_branch(repository, options = {})
  Git::Lib.new(nil, options[:log]).repository_default_branch(repository)
end