git2r (version 0.10.1)

note_create: Add note for a object

Description

Add note for a object

Usage

note_create(object, message, ref = note_default_ref(object@repo),
  author = default_signature(object@repo),
  committer = default_signature(object@repo), force = FALSE)
## S3 method for class 'git_blob':
note_create(object, message,
  ref = note_default_ref(object@repo),
  author = default_signature(object@repo),
  committer = default_signature(object@repo), force = FALSE)
## S3 method for class 'git_commit':
note_create(object, message,
  ref = note_default_ref(object@repo),
  author = default_signature(object@repo),
  committer = default_signature(object@repo), force = FALSE)
## S3 method for class 'git_tree':
note_create(object, message,
  ref = note_default_ref(object@repo),
  author = default_signature(object@repo),
  committer = default_signature(object@repo), force = FALSE)

Arguments

object

The object to annotate

message

Content of the note to add

ref

Canonical name of the reference to use. Default is note_default_ref.

author

Signature of the notes note author

committer

Signature of the notes note committer

force

Overwrite existing note. Default is FALSE

Value

• S4 class git_note

Examples

## 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_1 <- commit(repo, "Commit message 1")

## Create another commit
writeLines(c("Hello world!",
             "HELLO WORLD!"),
           file.path(path, "example.txt"))
add(repo, "example.txt")
commit_2 <- commit(repo, "Commit message 2")

## Check that notes is an empty list
notes(repo)

## Create note in default namespace
note_create(commit_1, "Note-1")

## Create note in named (review) namespace
note_create(commit_1, "Note-2", ref="refs/notes/review")
note_create(commit_2, "Note-3", ref="review")

## Create note on blob and tree
note_create(tree(commit_1), "Note-4")
note_create(tree(commit_1)["example.txt"], "Note-5")