git2r (version 0.33.0)

repository_head: Get HEAD for a repository

Description

Get HEAD for a repository

Usage

repository_head(repo = ".")

Value

NULL if unborn branch or not found. A git_branch if not a detached head. A git_commit if detached head

Arguments

repo

a path to a repository or a git_repository object. Default is '.'

Examples

if (FALSE) {
## Create and initialize a repository in a temporary directory
path <- tempfile(pattern="git2r-")
dir.create(path)
repo <- init(path)
config(repo, user.name = "Alice", user.email = "[e-mail]")

## Create a file, add and commit
writeLines("Hello world!", file.path(path, "example.txt"))
add(repo, "example.txt")
commit(repo, "Commit message")

## Get HEAD of repository
repository_head(repo)
}