Merge pull request #348 from carpentries/fix-347

set renv/sandbox as optional gitignore item
carpentries · Oct 7, 2022 · 0abf2de · 0abf2de
2 parents e99afc5 + 7e261a0
commit 0abf2de
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 9 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: sandpaper
 Title: Create and Curate Carpentries Lessons
-Version: 0.10.3
+Version: 0.10.4
 Authors@R: c(
     person(given = "Zhian N.",
            family = "Kamvar",

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,14 @@
+# sandpaper 0.10.4
+
+BUG FIX
+-------
+
+* `renv/sandbox` no longer required in `.gitignore`. A new bug introduced in
+  0.10.2 caused all lessons built before 0.10.2 to fail when rebuilt on CI.
+  This was due to the assumption that the .gitignore item `renv/sandbox` was
+  strictly necessary with no clear method to automatically update a file like
+  this (reported: @zkamvar, #347; fixed: @zkamvar, #348).
+
 # sandpaper 0.10.3
 
 BUG FIX
@@ -7,7 +18,7 @@ BUG FIX
   workflow templates folder was causing workflow update script to create pull
   requests for the workflows every week when they should have been much less
   frequent (the irony of this commit is that it will trigger another pull
-  request).
+  request) (fixed: @zkamvar, #346).
 
 # sandpaper 0.10.2
 
@@ -16,6 +27,7 @@ BUG FIX
 
 * The default `.gitignore` now has `renv/sandbox` to avoid a sandbox directory
   from being tracked by git. (see https://github.com/rstudio/renv/issues/1088)
+  (reported: @zkamvar; #344, fixed: @zkamvar, #343)
 
 CONTINUOUS INTEGRATION
 ----------------------

diff --git a/R/utils.R b/R/utils.R
@@ -191,7 +191,7 @@ check_order <- function(order, what) {
 # to reload this thing every time we need it 
 gitignore_items <- function() {
   ours <- readLines(template_gitignore(), encoding = "UTF-8")
-  ours[!grepl("^([#].+?|)$", trimws(ours))]
+  ours[!grepl("^([#].+?|.+? # OPTIONAL|)$", trimws(ours))]
 }
 #nocov end
 
diff --git a/inst/templates/gitignore-template.txt b/inst/templates/gitignore-template.txt
@@ -49,5 +49,5 @@ docs/
 # translation temp files
 po/*~
 
-# renv sandbox
-renv/sandbox
+# renv sandbox needed for renv version 0.16.0
+renv/sandbox # OPTIONAL
diff --git a/tests/testthat/_snaps/create_lesson.md b/tests/testthat/_snaps/create_lesson.md
@@ -25,7 +25,6 @@
       .Renviron
       docs/
       po/*~
-      renv/sandbox
 
 # Destruction of the .gitignore file renders the lesson incorrect [ansi]
 
@@ -54,7 +53,6 @@
       .Renviron
       docs/
       po/*~
-      renv/sandbox
 
 # Destruction of the .gitignore file renders the lesson incorrect [unicode]
 
@@ -83,7 +81,6 @@
       .Renviron
       docs/
       po/*~
-      renv/sandbox
 
 # Destruction of the .gitignore file renders the lesson incorrect [fancy]
 
@@ -112,5 +109,4 @@
       .Renviron
       docs/
       po/*~
-      renv/sandbox