Add note for a object

note_create(
  object = NULL,
  message = NULL,
  ref = NULL,
  author = NULL,
  committer = NULL,
  force = FALSE
)

Arguments

object

The object to annotate (git_blob, git_commit or git_tree).

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

git_note

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 = "[email protected]") ## 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") }