Polishing

Author: hadley

R/snapshot-github.R

@@ -36,7 +36,7 @@ snap_download_hint <- function() {
   run_id <- Sys.getenv("GITHUB_RUN_ID")
 
   sprintf(
-    "* Call `gh_download_snaps(\"%s\", %s)` to download the snapshots from GitHub.\n",
+    "* Call `snapshot_download_gh(\"%s\", %s)` to download the snapshots from GitHub.\n",
     repository,
     run_id
   )

R/snapshot.R

@@ -368,7 +368,7 @@ snapshot_accept_hint <- function(variant, file, reset_output = TRUE) {
   }
 
   paste0(
-    snap_download_hint(),
+    if (on_gh()) snap_download_hint(),
     cli::format_inline(
       "* Run {.run testthat::snapshot_accept('{name}')} to accept the change."
     ),

tests/testthat/_snaps/snapshot-file.md

@@ -52,6 +52,7 @@
     Code
       cat(snapshot_review_hint("lala", "foo.r", check = TRUE, ci = TRUE))
     Output
+      * Call `snapshot_download_gh("r-lib/testthat", 123)` to download the snapshots from GitHub.
       * Run `testthat::snapshot_review('lala/')` to review changes
 
 # expect_snapshot_file validates its inputs

tests/testthat/test-snapshot-file.R

@@ -1,6 +1,3 @@
-test_that("diagonstics", {
-})
-
 test_that("expect_snapshot_file works", {
   path <- write_tmp_lines(letters)
   expect_snapshot_file(path, "foo.r", compare = compare_file_text)
@@ -164,6 +161,7 @@ test_that("snapshot_hint output differs in R CMD check", {
   snapshot_review_hint <- function(...) {
     testthat:::snapshot_review_hint(..., reset_output = FALSE)
   }
+  withr::local_envvar(GITHUB_ACTIONS = "false")
 
   expect_snapshot(cat(snapshot_review_hint(
     "lala",
@@ -187,7 +185,7 @@ test_that("snapshot_hint output differs in R CMD check", {
   withr::local_envvar(
     GITHUB_ACTIONS = "true",
     GITHUB_REPOSITORY = "r-lib/testthat",
-    GITHUB_JOB = "123"
+    GITHUB_RUN_ID = "123"
   )
   expect_snapshot(cat(snapshot_review_hint(
     "lala",

tests/testthat/test-snapshot.R

@@ -166,6 +166,8 @@ test_that("errors and warnings are folded", {
 # })
 
 test_that("hint is informative", {
+  withr::local_envvar("GITHUB_ACTIONS" = "false")
+
   expect_snapshot({
     cat(snapshot_accept_hint("_default", "bar.R", reset_output = FALSE))
     cat(snapshot_accept_hint("foo", "bar.R", reset_output = FALSE))