1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/note.R
\name{note_create}
\alias{note_create}
\title{Add note for a object}
\usage{
note_create(
object = NULL,
message = NULL,
ref = NULL,
author = NULL,
committer = NULL,
force = FALSE
)
}
\arguments{
\item{object}{The object to annotate (git_blob, git_commit or
git_tree).}
\item{message}{Content of the note to add}
\item{ref}{Canonical name of the reference to use. Default is
\code{note_default_ref}.}
\item{author}{Signature of the notes note author}
\item{committer}{Signature of the notes note committer}
\item{force}{Overwrite existing note. Default is FALSE}
}
\value{
git_note
}
\description{
Add note for a object
}
\examples{
\dontrun{
## 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 = "alice@example.org")
## 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")
}
}
|
