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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tidyverse.R
\name{use_tidy_thanks}
\alias{use_tidy_thanks}
\title{Identify contributors via GitHub activity}
\usage{
use_tidy_thanks(repo_spec = NULL, from = NULL, to = NULL)
}
\arguments{
\item{repo_spec}{Optional GitHub repo specification in any form accepted for
the \code{repo_spec} argument of \code{\link[=create_from_github]{create_from_github()}} (plain spec or a browser
or Git URL). A URL specification is the only way to target a GitHub host
other than \code{"github.com"}, which is the default.}
\item{from, to}{GitHub ref (i.e., a SHA, tag, or release) or a timestamp in
ISO 8601 format, specifying the start or end of the interval of interest,
in the sense of \verb{[from, to]}. Examples: "08a560d", "v1.3.0",
"2018-02-24T00:13:45Z", "2018-05-01". When \verb{from = NULL, to = NULL}, we set
\code{from} to the timestamp of the most recent (GitHub) release. Otherwise,
\code{NULL} means "no bound".}
}
\value{
A character vector of GitHub usernames, invisibly.
}
\description{
Derives a list of GitHub usernames, based on who has opened issues or pull
requests. Used to populate the acknowledgment section of package release blog
posts at \url{https://www.tidyverse.org/blog/}. If no arguments are given, we
retrieve all contributors to the active project since its last (GitHub)
release. Unexported helper functions, \code{releases()} and \code{ref_df()} can be
useful interactively to get a quick look at release tag names and a data
frame about refs (defaulting to releases), respectively.
}
\examples{
\dontrun{
# active project, interval = since the last release
use_tidy_thanks()
# active project, interval = since a specific datetime
use_tidy_thanks(from = "2020-07-24T00:13:45Z")
# r-lib/usethis, interval = since a certain date
use_tidy_thanks("r-lib/usethis", from = "2020-08-01")
# r-lib/usethis, up to a specific release
use_tidy_thanks("r-lib/usethis", from = NULL, to = "v1.1.0")
# r-lib/usethis, since a specific commit, up to a specific date
use_tidy_thanks("r-lib/usethis", from = "08a560d", to = "2018-05-14")
# r-lib/usethis, but with copy/paste of a browser URL
use_tidy_thanks("https://github.com/r-lib/usethis")
}
}
|
