-
Notifications
You must be signed in to change notification settings - Fork 8
/
add_github_actions_check.Rd
52 lines (50 loc) · 1.66 KB
/
add_github_actions_check.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/add_github_actions_check.R
\name{add_github_actions_check}
\alias{add_github_actions_check}
\title{Setup GitHub Actions to check package}
\usage{
add_github_actions_check(open = FALSE, overwrite = FALSE, quiet = FALSE)
}
\arguments{
\item{open}{A logical value. If \code{TRUE} (default) the file is opened in the
editor.}
\item{overwrite}{A logical value. If this file is already present and
\code{overwrite = TRUE}, it will be erased and replaced. Default is \code{FALSE}.}
\item{quiet}{A logical value. If \code{TRUE} messages are deleted. Default is
\code{FALSE}.}
}
\value{
No return value.
}
\description{
This function creates a configuration file (\code{.yaml}) to setup GitHub Actions
to check the package.
This workflow is derived
from \url{https://github.com/r-lib/actions/tree/v2-branch/examples}.
This file will be written as \code{.github/workflows/R-CMD-check.yaml}.
}
\details{
This workflow runs \verb{R CMD check} on the three major operating systems
(Ubuntu, macOS, and Windows) using the latest release of R. The package is
also checked on Ubuntu (latest version) using the development and previous
versions of R.
}
\examples{
\dontrun{
add_github_actions_check()
}
}
\seealso{
Other development functions:
\code{\link{add_dependencies}()},
\code{\link{add_github_actions_citation}()},
\code{\link{add_github_actions_codecov}()},
\code{\link{add_github_actions_document}()},
\code{\link{add_github_actions_pkgdown}()},
\code{\link{add_github_actions_render}()},
\code{\link{add_r_depend}()},
\code{\link{add_to_buildignore}()},
\code{\link{add_to_gitignore}()}
}
\concept{development functions}