Merge pull request #86 from KWB-R/dev

Release v0.2.0

Author: mrustl

.Rbuildignore

@@ -14,3 +14,4 @@ secrets.csv
 ^R\\.add_author.R$
 ^\.travis\.yml$
 ^\.github$
+^pkgdown$

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: kwb.pkgbuild
 Title: R package for standardised development at KWB
-Version: 0.1.9
+Version: 0.2.0
 Authors@R: 
     c(person(given = "Michael",
              family = "Rustler",
@@ -19,7 +19,7 @@ Authors@R:
 Description: Helper functions for automating R package development at KWB
     to a predefined style.
 License: MIT + file LICENSE
-URL: https://github.com/KWB-R/kwb.pkgbuild
+URL: https://kwb-r.github.io/kwb.pkgbuild, https://github.com/KWB-R/kwb.pkgbuild
 BugReports: https://github.com/KWB-R/kwb.pkgbuild/issues
 Imports: 
     callr,
@@ -36,7 +36,6 @@ Imports:
     rematch2,
     sessioninfo,
     stringr,
-    travis,
     usethis,
     withr,
     yaml
@@ -50,9 +49,8 @@ VignetteBuilder:
     knitr
 Remotes: 
     github::kwb-r/kwb.orcid,
-    github::kwb-r/kwb.utils,
-    github::ropenscilabs/travis@f2dd9a3640b0cd8266b0a813c8eaf6bf3775c83d
+    github::kwb-r/kwb.utils
 ByteCompile: true
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.1.1
+RoxygenNote: 7.1.2

LICENSE

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2018-2021 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
+Copyright (c) 2018-2022 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2018-2021 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
+Copyright (c) 2018-2022 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

NAMESPACE

@@ -11,7 +11,6 @@ export(get_pkgname)
 export(git_check_config)
 export(git_setup_user)
 export(set_github_user)
-export(use_appveyor)
 export(use_autopkgdown)
 export(use_badge_appveyor)
 export(use_badge_codecov)
@@ -36,7 +35,6 @@ export(use_pkg)
 export(use_pkg_skeleton)
 export(use_pkgdown)
 export(use_readme_md)
-export(use_travis)
 export(write_to_gitignore)
 export(write_to_rbuildignore)
 importFrom(callr,rcmd)
@@ -58,6 +56,7 @@ importFrom(httr,GET)
 importFrom(httr,status_code)
 importFrom(kwb.utils,catAndRun)
 importFrom(kwb.utils,defaultIfNULL)
+importFrom(kwb.utils,isNaOrEmpty)
 importFrom(kwb.utils,selectElements)
 importFrom(magrittr,"%>%")
 importFrom(openssl,base64_decode)
@@ -77,5 +76,3 @@ importFrom(usethis,use_pkgdown)
 importFrom(usethis,use_template)
 importFrom(utils,tail)
 importFrom(withr,with_dir)
-importFrom(yaml,as.yaml)
-importFrom(yaml,write_yaml)

NEWS.md

@@ -1,3 +1,12 @@
+# [kwb.pkgbuild 0.2.0](https://github.com/KWB-R/kwb.pkgbuild/releases/tag/v0.2.0) <small>2022-01-20</small>
+
+* Documentation website with `pkgdown (>= 2.0.2)` and new [KWB website](https://kompetenz-wasser.de):   - Design: now using `bootstrap5` and colors slightly adapted to KWB design. 
+  - URL to KWB logo was updated due to new website. 
+  - **Attention: URLs to projects (including logos) need to be corrected manually (for old `_pkgdown.yml` files**
+
+* Deleted functions for unused CIs `travis` and `appveyor`
+
+
 # [kwb.pkgbuild 0.1.9](https://github.com/KWB-R/kwb.pkgbuild/releases/tag/v0.1.9) <small>2021-09-10</small>
 
 * Fix `Rcmdcheck` workflow on GitHub Actions by explicitly adding default organisation `GITHUB_PAT`

R/use_appveyor.R

@@ -63,7 +63,7 @@ use_pkg <- function(
   }
 
   # Create PKGDOWN YML
-  use_pkgdown(author, copyright_holder$name)
+  use_pkgdown(author, copyright_holder$name, pkg, user, domain)
 
   # Update Github Actions
   use_ghactions()

R/use_pkg.R

@@ -4,35 +4,62 @@
 #'   kwb.pkgbuild:::kwb_author("rustler"))
 #' @param copyright_holder_name name of copyright holder
 #' (default: kwb.pkgbuild:::kwb_string())
+#' @param pkg name of KWB package (default: get_pkgname())
+#' @param user name of GitHub user/organisation (default: 'kwb-r')
+#' @param domain name of domain for webpage publishing (default: 'github')
 #' @return  performs usethis::use_pkgdown() and additionally writes _pkgdown.yml
 #' based on KWB styling
 #' @importFrom usethis use_pkgdown
+#' @importFrom kwb.utils isNaOrEmpty
 #' @export
 use_pkgdown <- function(
   author = kwb_author("rustler"),
-  copyright_holder_name = kwb_string()
+  copyright_holder_name = kwb_string(),
+  pkg = get_pkgname(),
+  user = "kwb-r",
+  domain = "github"
 )
 {
   usethis::use_pkgdown()
 
+  pkgdown_url <- ""
+
+  if(domain == "github" & !kwb.utils::isNaOrEmpty(pkg) & !kwb.utils::isNaOrEmpty(user)) {
+  pkgdown_url <- yaml::as.yaml(list(url = sprintf("https://%s.github.io/%s",
+                                                  tolower(user),
+                                                  tolower(pkg)))
+  )
+  }
+
   authors <- stats::setNames(list(list(href = author$url)), author$name)
 
   if (copyright_holder_name == kwb_string()) {
 
     authors <- c(authors, stats::setNames(nm = copyright_holder_name, list(list(
       href = "http://www.kompetenz-wasser.de",
       html = paste0(
-        "<img src='http://www.kompetenz-wasser.de/wp-content/uploads/",
-        "2017/08/cropped-logo-kwb_klein-new.png' height='24' />")
+        "<img src='https://publications.kompetenz-wasser.de/img/KWB-Logo.svg",
+        " alt='KWB' width='72' />")
     ))))
   }
 
+
+  design <- list(bootstrap = 5L,
+                 bootswatch = "cerulean",
+                 bslib = list(bg = "#ffffff",
+                              fg = "#000000",
+                              primary = "#007aff",
+                              `border-radius` = "0.5rem",
+                              `btn-border-radius` = "0.25rem"))
+
   pkgdown_yaml <- yaml::as.yaml(list(
     authors = authors,
-    template = list(params = list(bootswatch = "cerulean")),
+    template = design,
     development = list(mode = "auto")
   ))
 
+  pkgdown_yaml <- paste0(pkgdown_url, pkgdown_yaml)
+
   writeLines(pkgdown_yaml, "_pkgdown.yml")
 
   write_to_rbuildignore("^_pkgdown\\.yml$")