[mirror] Opinionated R package quickstart
Exported some helpers
+50
-7
+3
NAMESPACE
+3
NAMESPACE
+3
-6
R/bootstrapper.R
+3
-6
R/bootstrapper.R
···
172
172
#' workflow references.
173
173
#'
174
174
#' @return Invisibly returns `NULL`.
175
-
#' @keywords internal
176
-
#' @noRd
175
+
#' @export
177
176
setup_gha <- function() {
178
177
usethis::use_github_action("check-standard", badge = TRUE)
179
178
usethis::use_github_action("test-coverage", badge = TRUE)
···
199
198
#' Writes a default Dependabot configuration for GitHub Actions.
200
199
#'
201
200
#' @return Invisibly returns `NULL`.
202
-
#' @keywords internal
203
-
#' @noRd
201
+
#' @export
204
202
setup_dependabot <- function() {
205
203
copy_template_file("dependabot.yml", fs::path(".github", "dependabot.yml"))
206
204
}
···
210
208
#' Copies an opinionated, concise AGENTS.md for R package development.
211
209
#'
212
210
#' @return Invisibly returns `NULL`.
213
-
#' @keywords internal
214
-
#' @noRd
211
+
#' @export
215
212
setup_agents <- function() {
216
213
copy_template_file("AGENTS.md", "AGENTS.md")
217
214
}
+1
-1
man/bootstrapper-package.Rd
+1
-1
man/bootstrapper-package.Rd
···
5
5
\alias{bootstrapper-package}
6
6
\title{bootstrapper: Opinionated R Package Quickstart}
7
7
\description{
8
-
Quickly start new R packages, adding some opinionated default GHA, suggested extensions, etc.
8
+
Bootstrap new R packages with strongly opinionated defaults. Creates the package scaffold, wires up tests, README and NEWS, configures GitHub Actions and Dependabot, adds Air/Jarl setup, and drop in a default AGENTS.md for building R packages.
9
9
}
10
10
\seealso{
11
11
Useful links:
+14
man/setup_agents.Rd
+14
man/setup_agents.Rd
···
1
+
% Generated by roxygen2: do not edit by hand
2
+
% Please edit documentation in R/bootstrapper.R
3
+
\name{setup_agents}
4
+
\alias{setup_agents}
5
+
\title{Configure AGENTS Defaults}
6
+
\usage{
7
+
setup_agents()
8
+
}
9
+
\value{
10
+
Invisibly returns \code{NULL}.
11
+
}
12
+
\description{
13
+
Copies an opinionated, concise AGENTS.md for R package development.
14
+
}
+14
man/setup_dependabot.Rd
+14
man/setup_dependabot.Rd
···
1
+
% Generated by roxygen2: do not edit by hand
2
+
% Please edit documentation in R/bootstrapper.R
3
+
\name{setup_dependabot}
4
+
\alias{setup_dependabot}
5
+
\title{Configure Dependabot Defaults}
6
+
\usage{
7
+
setup_dependabot()
8
+
}
9
+
\value{
10
+
Invisibly returns \code{NULL}.
11
+
}
12
+
\description{
13
+
Writes a default Dependabot configuration for GitHub Actions.
14
+
}
+15
man/setup_gha.Rd
+15
man/setup_gha.Rd
···
1
+
% Generated by roxygen2: do not edit by hand
2
+
% Please edit documentation in R/bootstrapper.R
3
+
\name{setup_gha}
4
+
\alias{setup_gha}
5
+
\title{Configure GitHub Actions Defaults}
6
+
\usage{
7
+
setup_gha()
8
+
}
9
+
\value{
10
+
Invisibly returns \code{NULL}.
11
+
}
12
+
\description{
13
+
Sets up standard GitHub Actions used by this package template and updates
14
+
workflow references.
15
+
}