From 0036333b2bad40205b9b296080347206d704ac3d Mon Sep 17 00:00:00 2001 From: "J.P. Le Cavalier" Date: Thu, 15 Aug 2024 20:24:40 -0700 Subject: [PATCH] Adding pre-commit hook for README even when not overwritten. Fixes #2035. --- NEWS.md | 3 +++ R/readme.R | 14 +++++++------- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/NEWS.md b/NEWS.md index 311e2707d..d4be383d9 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,6 +2,9 @@ ## Bug fixes and minor improvements +* `use_readme_rmd()` now adds the pre-commit hook for making sure README.Rmd + was knited before commit (@jplecavalier, #2035). + * `use_package()` now decreases a package minimum version required when `min_version` is lower than what is currently specified in the DESCRIPTION file (@jplecavalier, #1957). diff --git a/R/readme.R b/R/readme.R index cf1a3651c..0e7e6a2a5 100644 --- a/R/readme.R +++ b/R/readme.R @@ -48,6 +48,13 @@ use_readme_rmd <- function(open = rlang::is_interactive()) { github_spec = repo_spec ) + if (uses_git()) { + use_git_hook( + "pre-commit", + render_template("readme-rmd-pre-commit.sh") + ) + } + new <- use_template( if (is_pkg) "package-README" else "project-README", "README.Rmd", @@ -65,13 +72,6 @@ use_readme_rmd <- function(open = rlang::is_interactive()) { )) } - if (uses_git()) { - use_git_hook( - "pre-commit", - render_template("readme-rmd-pre-commit.sh") - ) - } - invisible(TRUE) }