Merge pull request #76 from KWB-R/dev

Dev

Author: mrustl

.travis.yml

@@ -1,13 +1,25 @@
-##############################################################################
-### Autogenerated with R package kwb.pkgbuild v0.0.0.9000
-### (installed from 'local' source code on 2019-06-17)
-### by calling the function kwb.pkgbuild::use_travis()
-### (file created at: 2019-06-17 13:25:13)
-##############################################################################
+################################################################################
+### generated-with:
+###   type: R-package
+###   name: kwb.pkgbuild
+###   version: 0.1.5
+###   installed-from: Github (kwb-r/kwb.pkgbuild@d34caef)
+###   installed-on: '2020-10-09'
+### generated-by:
+###   user: mrustl
+###   function-call: kwb.pkgbuild::use_travis()
+### generated-on: 2020-10-09 08:24:34
+################################################################################
 
 
 language: r
+pandoc_version: 2.7.3
 sudo: required
+addons:
+  apt:
+    packages:
+    - libharfbuzz-dev
+    - libfribidi-dev
 cache: packages
 r_packages:
 - remotes
@@ -26,6 +38,7 @@ matrix:
       skip_cleanup: 'true'
       on:
         branch:
+        - main
         - master
         - dev
   - r: oldrel

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: kwb.pkgbuild
 Title: R package for standardised development at KWB
-Version: 0.1.4
+Version: 0.1.5
 Authors@R: 
     c(person(given = "Michael",
              family = "Rustler",

NEWS.md

@@ -1,3 +1,15 @@
+# [kwb.pkgbuild 0.1.6](https://github.com/KWB-R/kwb.pkgbuild/releases/tag/v0.1.6) <small>2020-10-09</small>
+
+* Update default GitHub branch to `main` since 2020-10-01 (see: [Article](https://www.zdnet.com/article/github-to-replace-master-with-main-starting-next-month/))
+
+* `add_creation_metadata`: write creation metadata in yaml format as default 
+
+* travis.yml template: add dependencies required for pkgdown (>= 1.6.1) installation
+
+# [kwb.pkgbuild 0.1.5](https://github.com/KWB-R/kwb.pkgbuild/releases/tag/v0.1.5) <small>2020-06-25</small>
+
+* Update Travis-CI badges after migrating KWB-R build from travis-ci.org to .com (#72) 
+
 # [kwb.pkgbuild 0.1.4](https://github.com/KWB-R/kwb.pkgbuild/releases/tag/v0.1.4) <small>2020-06-23</small>
 
 * Fix use_travis_deploy() to correctly generate key for using pkgdown on Travis to deploy to gh-pages (#70) 

R/create_empty_branch.R

@@ -82,7 +82,7 @@ create_empty_branch <- function(
     sprintf('"%s" rm -rf .', git_exe),
     sprintf('"%s" commit --allow-empty -m "Initial gh-pages commit"', git_exe),
     sprintf('"%s" push origin %s', git_exe, branch),
-    sprintf('"%s" checkout master', git_exe)
+    sprintf('"%s" checkout main', git_exe)
   )
 
   if (set_githubuser) cmd <- c(

R/grammars.R

@@ -5,7 +5,7 @@ grammars <- list(
     url = "[![<title>](<src>)](<href>)",
     src = "<address>/<path_1><params>",
     href = "<address>/<path_2>",
-    branch = "master"
+    branch = "main"
   ),
   appveyor = list(
     title = "Appveyor build Status",
@@ -16,7 +16,7 @@ grammars <- list(
   ),
   travis = list(
     title = "Travis build Status",
-    address = "https://travis-ci.org",
+    address = "https://travis-ci.com",
     path_1 = "<path_2>.svg?branch=<branch>",
     path_2 = "<user>/<pkgname>",
     params = ""

R/helper.R

@@ -203,41 +203,67 @@ write_git_batch_and_execute <- function(
   })
 }
 
-
-
 # add_creation_metadata --------------------------------------------------
 
 #' @noRd
 #' @keywords internal
 #' @importFrom sessioninfo package_info
-add_creation_metadata <- function()
+add_creation_metadata <- function(as_yaml = TRUE, line_sep = "\n")
 {
-  calling_function_name <- deparse(sys.calls()[[1]])
+  function_call <- deparse(sys.calls()[[1L]])
 
   package_name <- "kwb.pkgbuild"
 
-  meta_creation <- sessioninfo::package_info(package_name)
+  metadata <- sessioninfo::package_info(package_name)
 
-  meta_creation <- meta_creation[meta_creation$package == package_name, ]
+  metadata <- metadata[metadata$package == package_name, ]
 
-  fmt <- paste(collapse = "\n", c(
-"##############################################################################",
-"### Autogenerated with R package %s v%s",
-"### (installed from '%s' source code on %s)",
-"### by calling the function %s",
-"### (file created at: %s)",
-"##############################################################################",
-"",
-""))
+  comment_block <- function(x) {
+    separator_line <- kwb.utils::repeated("#", 80L)
+    paste(collapse = line_sep, c(
+      separator_line,
+      paste("###", x),
+      separator_line,
+      "",
+      ""
+    ))
+  }
 
-  sprintf(fmt,
-          meta_creation$package,
-          meta_creation$ondiskversion,
-          meta_creation$source,
-          meta_creation$date,
-          calling_function_name,
-          Sys.time()
-          )
+  if (as_yaml) {
+
+    info <- list(
+      "generated-with" = list(
+        type = "R-package",
+        name = metadata$package,
+        version = metadata$ondiskversion,
+        "installed-from" = metadata$source,
+        "installed-on" = metadata$date
+      ),
+      "generated-by" = list(
+        user = kwb.utils::user(),
+        "function-call" = function_call
+      ),
+      "generated-on" = as.character(Sys.time())
+    )
 
+    return(comment_block(
+      # Create yaml text and split it into separate lines
+      strsplit(yaml::as.yaml(info, line.sep = line_sep), line_sep)[[1L]]
+    ))
+  }
 
+  sprintf(
+    comment_block(c(
+      "Generated with R package %s v%s",
+      "(installed from '%s' source code on %s)",
+      "by calling %s",
+      "(file created on: %s)"
+    )),
+    metadata$package,
+    metadata$ondiskversion,
+    metadata$source,
+    metadata$date,
+    paste(function_call, collapse = paste0(line_sep, "###")),
+    Sys.time()
+  )
 }

R/use_appveyor.R

@@ -1,4 +1,4 @@
-# read_gitlab_ci_template ------------------------------------------------------
+# ci_appveyor_template ---------------------------------------------------------
 
 #' @keywords internal
 #' @noRd
@@ -7,7 +7,6 @@ ci_appveyor_template <- function()
   read_template("ci_appveyor.yml")
 }
 
-
 # write_ci_appveyor ------------------------------------------------------------
 
 #' @keywords internal
@@ -26,9 +25,6 @@ write_ci_appveyor <- function(yml_vector, dest_dir = getwd(), ignore)
   }
 }
 
-
-
-
 # use_appveyor ----------------------------------------------------------------
 
 # use_appveyor with KWB default style
@@ -40,7 +36,7 @@ write_ci_appveyor <- function(yml_vector, dest_dir = getwd(), ignore)
 #' @export
 #'
 use_appveyor <- function(
-dest_dir = getwd(), yml_vector = ci_appveyor_template()
+  dest_dir = getwd(), yml_vector = ci_appveyor_template()
 )
 {
   write_ci_appveyor(yml_vector, dest_dir = dest_dir, ignore = TRUE)

R/use_autopkgdown.R

@@ -38,16 +38,16 @@ use_autopkgdown <- function(
     ...
   )
 
-  # Create .gitlab-ci.yml for "master" branch with "docs" folder
+  # Create .gitlab-ci.yml for "main" branch with "docs" folder
   use_gitlab_ci_docs(dest_dir = file.path(dest_dir, repo))
 
   # Update .travis.yml
   use_travis(auto_build_pkgdown = TRUE, dbg)
 
-  # Delete .gitlab-ci.yml (if existing in "master" branch)
+  # Delete .gitlab-ci.yml (if existing in "main" branch)
   fs::file_delete(".gitlab-ci.yml")
 
-  # Delete "docs" folder (if existing in "master" branch)
+  # Delete "docs" folder (if existing in "main" branch)
   #fs::dir_delete(path = "docs")
 }
 

R/use_pkg.R

@@ -70,7 +70,7 @@ use_pkg <- function(
   } else {
     # Create .travis.yml
     use_travis()
-    # Create .gitlab-ci.yml for "master" branch with "docs" folder
+    # Create .gitlab-ci.yml for "main" branch with "docs" folder
     fs::dir_create("docs")
     use_gitlab_ci_docs()
   }

README.md

@@ -1,5 +1,5 @@
 [![Appveyor build Status](https://ci.appveyor.com/api/projects/status/github/KWB-R/kwb.pkgbuild?branch=master&svg=true)](https://ci.appveyor.com/project/KWB-R/kwb-pkgbuild/branch/master)
-[![Travis build Status](https://travis-ci.org/KWB-R/kwb.pkgbuild.svg?branch=master)](https://travis-ci.org/KWB-R/kwb.pkgbuild)
+[![Travis build Status](https://travis-ci.com/KWB-R/kwb.pkgbuild.svg?branch=master)](https://travis-ci.com/KWB-R/kwb.pkgbuild)
 [![codecov](https://codecov.io/github/KWB-R/kwb.pkgbuild/branch/master/graphs/badge.svg)](https://codecov.io/github/KWB-R/kwb.pkgbuild)
 [![Project Status](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/kwb.pkgbuild)]()