Rename a branch

Share:

Description

Rename a branch

Usage

1
2
3
4
branch_rename(branch, name, force = FALSE)

## S4 method for signature 'git_branch'
branch_rename(branch, name, force = FALSE)

Arguments

branch

Branch to rename

name

The new name for the branch

force

Overwrite existing branch. Default is FALSE

Value

invisible renamed S4 class git_branch

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
## Not run: 
## 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="alice@example.org")
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)

## End(Not run)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.