git2r (version 0.7)

branch_rename: Rename a branch

Description

Rename a branch

Usage

branch_rename(branch, name, force = FALSE, message = NULL, who = NULL)
## S3 method for class 'git_branch':
branch_rename(branch, name, force = FALSE,
  message = NULL, who = NULL)

Arguments

branch

Branch to rename

name

The new name for the branch

force

Overwrite existing branch. Default is FALSE

message

The one line long message to the reflog. If NULL, the default value is appended

who

The identity that will be used to populate the reflog entry. Default is NULL, which gives the default signature.

Value

• invisible renamed S4 class git_branch

Examples

## Initialize a temporary repository
path <- tempfile(pattern="git2r-")
dir.create(path)
repo <- init(path)

## Config user and commit a file
config(repo, user.name="Alice", user.email="[e-mail]")
writeLines("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do",
           file.path(path, "example.txt"))
add(repo, "example.txt")
commit(repo, "First commit message")

## Rename 'master' branch to 'dev'
branches(repo)
branch_rename(head(repo), "dev")
branches(repo)