Add use_makefile() and use_jenkinsfile().

NAMESPACE

@@ -101,9 +101,11 @@ export(use_github_links)
 export(use_github_release)
 export(use_gitlab_ci)
 export(use_gpl3_license)
+export(use_jenkins)
 export(use_lgpl_license)
 export(use_lifecycle_badge)
 export(use_logo)
+export(use_make)
 export(use_mit_license)
 export(use_namespace)
 export(use_news_md)

NEWS.md

@@ -1,5 +1,8 @@
 # usethis (development version)
 
+* `use_make()` and `use_jenkins()` add a Makefile and Jenkinsfile, respectively
+  (@ryapric, #501) 
+
 # usethis 1.5.0
 
 ## Git, GitHub (and GitLab)

R/jenkins.R

@@ -0,0 +1,19 @@
+#' Create Jenkinsfile for Jenkins CI Pipelines
+#'
+#' `use_jenkins()` adds a basic Jenkinsfile for R packages to the project root
+#' directory. The Jenkinsfile stages take advantage of calls to `make`, and so
+#' calling this function will also run `use_make()` if a Makefile does not
+#' already exist at the project root.
+#'
+#' @seealso The [documentation on Jenkins
+#'   Pipelines](https://jenkins.io/doc/book/pipeline/jenkinsfile).
+#' @seealso [use_make()]
+#' @export
+use_jenkins <- function() {
+  use_make()
+  use_template(
+    "Jenkinsfile",
+    data = list(name = project_name())
+  )
+  use_build_ignore("Jenkinsfile")
+}

R/make.R

@@ -0,0 +1,19 @@
+#' Create Makefile
+#'
+#' `use_make()` adds a basic Makefile to the project root directory.
+#'
+#' @seealso The [documentation for GNU
+#'   Make](https://www.gnu.org/software/make/manual/html_node).
+#' @export
+use_make <- function() {
+  use_template(
+    "Makefile",
+    data = list(name = project_name())
+  )
+  use_build_ignore("Makefile")
+}
+
+uses_make <- function(base_path = proj_get()) {
+  makefile_path <- proj_path("Makefile")
+  file_exists(makefile_path)
+}

inst/templates/Jenkinsfile

@@ -0,0 +1,21 @@
+pipeline {
+  agent any {
+    stages {
+      stage('Build') {
+        steps {
+          make build
+        }
+      }
+      stage('Check') {
+        steps {
+          make check
+        }
+      }
+      stage('Clean') {
+        steps {
+          make clean
+        }
+      }
+    }
+  }
+}

inst/templates/Makefile

@@ -0,0 +1,26 @@
+# h/t to @jimhester and @yihui for this parse block:
+# https://github.com/yihui/knitr/blob/dc5ead7bcfc0ebd2789fe99c527c7d91afb3de4a/Makefile#L1-L4
+# Note the portability change as suggested in the manual:
+# https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Writing-portable-packages
+PKGNAME = `sed -n "s/Package: *\([^ ]*\)/\1/p" DESCRIPTION`
+PKGVERS = `sed -n "s/Version: *\([^ ]*\)/\1/p" DESCRIPTION`
+
+
+all: check
+
+build:
+	R CMD build .
+
+check: build
+	R CMD check --no-manual $(PKGNAME)_$(PKGVERS).tar.gz
+
+install_deps:
+	Rscript \
+	-e 'if (!requireNamespace("remotes") install.packages("remotes")' \
+	-e 'remotes::install_deps(dependencies = TRUE)'
+
+install: install_deps build
+	R CMD INSTALL $(PKGNAME)_$(PKGVERS).tar.gz
+
+clean:
+	@rm -rf $(PKGNAME)_$(PKGVERS).tar.gz $(PKGNAME).Rcheck

tests/testthat/test-use-jenkins.R

@@ -0,0 +1,8 @@
+context("use_jenkins")
+
+test_that("use_jenkins() creates a Makefile AND a Jenkinsfile at project root", {
+  pkg <- scoped_temporary_package()
+  use_jenkins()
+  expect_proj_file("Makefile")
+  expect_proj_file("Jenkinsfile")
+})

tests/testthat/test-use-make.R

@@ -0,0 +1,7 @@
+context("use_makefile")
+
+test_that("use_make() creates a Makefile at project root", {
+  pkg <- scoped_temporary_package()
+  use_make()
+  expect_proj_file("Makefile")
+})