Rename build_universe() to write_universe_manifest()

NAMESPACE

@@ -3,12 +3,12 @@
 export(assert_cran_url)
 export(assert_package)
 export(assert_release_exists)
-export(build_universe)
 export(get_current_versions)
 export(record_versions)
 export(review_pull_request)
 export(review_pull_requests)
 export(try_message)
+export(write_universe_manifest)
 importFrom(gh,gh)
 importFrom(jsonlite,parse_json)
 importFrom(jsonlite,read_json)

NEWS.md

@@ -1,7 +1,8 @@
 # r.releases.internals 0.0.10
 
 * Automatically merge GitLab URLs with non-"upcoming" releases.
-* `build_universe()` omits `"branch": "release"` from listings originating from custom owners. The new `release_exceptions` can accept `"https://github.com/cran"`, for example.
+* Rename `build_universe()` to `write_universe_manifest()`. 
+* `write_universe_manifest()` omits `"branch": "release"` from listings originating from a short list of prespecified GitHub/GitLab owners. The new `release_exceptions` can accept `"https://github.com/cran"`, for example.
 
 # r.releases.internals 0.0.9
 

R/build_universe.R → R/write_universe_manifest.R

@@ -1,17 +1,17 @@
-#' @title Build the universe.
+#' @title Build the `packages.json` manifest for the universe.
 #' @export
 #' @keywords internal
-#' @description Create the `r-universe` `packages.json` file
+#' @description Create the R-universe `packages.json` file
 #'   from constituent text files with URLs.
 #' @return NULL (invisibly)
 #' @param input Character of length 1, directory path with the
 #'   text file listings of R releases.
 #' @param output Character of length 1, file path where the
-#'   `r-universe` `packages.json` file will be written.
+#'   R-universe `packages.json` file will be written.
 #' @param release_exceptions Character vector of URLs of GitHub owners
 #'   where `"branch": "*release"` should be omitted. Example:
 #'   `"https://github.com/cran"`.
-build_universe <- function(
+write_universe_manifest <- function(
   input = getwd(),
   output = "packages.json",
   release_exceptions = character(0L)

tests/test-build_universe.R → tests/test-write_universe_manifest.R

@@ -7,7 +7,10 @@ writeLines(
   file.path(packages, "jsonlite")
 )
 universe <- file.path(tempfile(), "out")
-r.releases.internals::build_universe(input = packages, output = universe)
+r.releases.internals::write_universe_manifest(
+  input = packages,
+  output = universe
+)
 json <- jsonlite::read_json(universe)
 exp <- list(
   list(
@@ -42,7 +45,7 @@ writeLines(
   file.path(packages, "quarto")
 )
 universe <- file.path(tempfile(), "out")
-r.releases.internals::build_universe(
+r.releases.internals::write_universe_manifest(
   input = packages,
   output = universe,
   release_exceptions = c(
@@ -85,7 +88,10 @@ writeLines(
 )
 universe <- file.path(tempfile(), "out")
 out <- try(
-  r.releases.internals::build_universe(input = packages, output = universe),
+  r.releases.internals::write_universe_manifest(
+    input = packages,
+    output = universe
+  ),
   silent = TRUE
 )
 stopifnot(inherits(out, "try-error"))
@@ -108,7 +114,10 @@ writeLines(
   file.path(packages, "paws.analytics")
 )
 universe <- file.path(tempfile(), "out")
-r.releases.internals::build_universe(input = packages, output = universe)
+r.releases.internals::write_universe_manifest(
+  input = packages,
+  output = universe
+)
 out <- jsonlite::read_json(path = universe)
 exp <- list(
   list(
@@ -145,7 +154,10 @@ writeLines(
 )
 universe <- file.path(tempfile(), "out")
 out <- try(
-  r.releases.internals::build_universe(input = packages, output = universe),
+  r.releases.internals::write_universe_manifest(
+    input = packages,
+    output = universe
+  ),
   silent = TRUE
 )
 stopifnot(
@@ -173,7 +185,10 @@ writeLines(
 )
 universe <- file.path(tempfile(), "out")
 out <- try(
-  r.releases.internals::build_universe(input = packages, output = universe),
+  r.releases.internals::write_universe_manifest(
+    input = packages,
+    output = universe
+  ),
   silent = TRUE
 )
 stopifnot(inherits(out, "try-error"))
@@ -211,7 +226,10 @@ writeLines(
 )
 universe <- file.path(tempfile(), "out")
 out <- try(
-  r.releases.internals::build_universe(input = packages, output = universe),
+  r.releases.internals::write_universe_manifest(
+    input = packages,
+    output = universe
+  ),
   silent = TRUE
 )
 stopifnot(inherits(out, "try-error"))
@@ -242,7 +260,10 @@ writeLines(
 )
 universe <- file.path(tempfile(), "out")
 out <- try(
-  r.releases.internals::build_universe(input = packages, output = universe),
+  r.releases.internals::write_universe_manifest(
+    input = packages,
+    output = universe
+  ),
   silent = TRUE
 )
 stopifnot(inherits(out, "try-error"))