Merge pull request #82 from KWB-R/dev

mrustl · web-flow · commit c429bfd8898d · 2021-02-23T21:57:10.000+01:00
Release v0.1.7
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -19,6 +19,10 @@ jobs:
 
       - uses: r-lib/actions/setup-pandoc@master
 
+      - name: Install system dependencies
+        if: runner.os == 'MacOS'
+        run: brew install harfbuzz fribidi
+        
       - name: Query dependencies
         run: |
           install.packages('remotes')
@@ -36,6 +40,7 @@ jobs:
       - name: Install dependencies
         run: |
           remotes::install_deps(dependencies = TRUE)
+          remotes::install_github("kwb-r/kwb.pkgbuild")
           install.packages("pkgdown", type = "binary")
         shell: Rscript {0}
 
@@ -46,4 +51,5 @@ jobs:
         run: |
           git config --local user.email "actions@github.com"
           git config --local user.name "GitHub Actions"
-          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
+          Rscript -e 'kwb.pkgbuild::deploy_to_branch_with_extra_files()'
+
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -22,6 +22,10 @@ jobs:
 
       - uses: r-lib/actions/setup-pandoc@master
 
+      - name: Install system dependencies
+        if: runner.os == 'MacOS'
+        run: brew install harfbuzz fribidi
+        
       - name: Query dependencies
         run: |
           install.packages('remotes')
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: kwb.pkgbuild
 Title: R package for standardised development at KWB
-Version: 0.1.6
+Version: 0.1.7
 Authors@R: 
     c(person(given = "Michael",
              family = "Rustler",
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2018-2019 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
+Copyright (c) 2018-2021 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
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2018-2019 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
+Copyright (c) 2018-2021 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
diff --git a/NAMESPACE b/NAMESPACE
@@ -17,6 +17,8 @@ export(use_badge_appveyor)
 export(use_badge_codecov)
 export(use_badge_cran)
 export(use_badge_ghactions)
+export(use_badge_ghactions_pkgdown)
+export(use_badge_ghactions_rcmdcheck)
 export(use_badge_lifecycle)
 export(use_badge_travis)
 export(use_codecov)
@@ -42,6 +44,7 @@ importFrom(crayon,bold)
 importFrom(desc,desc)
 importFrom(desc,desc_get)
 importFrom(desc,desc_set)
+importFrom(fs,dir_copy)
 importFrom(fs,dir_create)
 importFrom(fs,dir_delete)
 importFrom(fs,dir_ls)
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,7 @@
+# [kwb.pkgbuild 0.1.7](https://github.com/KWB-R/kwb.pkgbuild/releases/tag/v0.1.7) <small>2021-02-23</small>
+
+* Improve re-usability of Github Actions badges  (for R package `kwb.pkgstatus`)
+
 # [kwb.pkgbuild 0.1.6](https://github.com/KWB-R/kwb.pkgbuild/releases/tag/v0.1.6) <small>2020-11-24</small>
 
 * Add function `deploy_to_branch_with_extra_files()` for using github-actions to 
diff --git a/R/use_autopkgdown.R b/R/use_autopkgdown.R
@@ -39,9 +39,6 @@ use_autopkgdown <- function(
   # Create .gitlab-ci.yml for "main" branch with "docs" folder
   use_gitlab_ci_docs(dest_dir = file.path(dest_dir, repo))
 
-  # Update Github Actions
-  use_ghactions()
-
   # Delete .gitlab-ci.yml (if existing in "main" branch)
   fs::file_delete(".gitlab-ci.yml")
 
diff --git a/R/use_badges.R b/R/use_badges.R
@@ -42,36 +42,71 @@ use_badge_travis <- function(repo = NULL, user = "KWB-R")
   )
 }
 
-# use_badge_ghactions ----------------------------------------------------------
+# use_badge_ghactions_rcmdcheck ------------------------------------------------
 
-#' Badge Github Actions
+#' Badge Github Actions RCMD Check
 #' @param repo name of repository (default: NULL)
 #' @param user user name or organisation under which repository defined in
 #' parameter "repo" is hosted (default: KWB-R")
+#' @param branch default: NULL (i.e. use "default" branch) or user defined branch
+#' (e.g. "dev")
 #' @return generates travis badge link
 #' @export
-use_badge_ghactions <- function(repo = NULL, user = "KWB-R")
+use_badge_ghactions_rcmdcheck <- function(repo = NULL, user = "KWB-R",
+                                          branch = NULL)
 {
-  sprintf("%s\n%s",
-
   kwb.utils::resolve(
     "url",
     grammars$general,
     grammars$ghactions_rcmdcheck,
     user = user,
-    pkgname = get_pkgname(repo)
-  ),
+    pkgname = get_pkgname(repo),
+    params = ifelse(is.null(branch), "", sprintf("?branch=%s", branch))
+
+  )
+
+}
+
+#' Badge Github Actions Pkgdown
+#' @param repo name of repository (default: NULL)
+#' @param user user name or organisation under which repository defined in
+#' parameter "repo" is hosted (default: KWB-R")
+#' @param branch default: NULL (i.e. use "default" branch) or user defined branch
+#' (e.g. "dev")
+#' @return generates Github Actions Pkgdown badge link
+#' @export
+use_badge_ghactions_pkgdown <- function(repo = NULL, user = "KWB-R", branch = NULL)
+{
   kwb.utils::resolve(
     "url",
     grammars$general,
     grammars$ghactions_pkgdown,
     user = user,
-    pkgname = get_pkgname(repo)
-  )
+    pkgname = get_pkgname(repo),
+    params = ifelse(is.null(branch), "", sprintf("?branch=%s", branch))
   )
 
 }
 
+# use_badge_ghactions ----------------------------------------------------------
+
+#' Badge Github Actions
+#' @param repo name of repository (default: NULL)
+#' @param user user name or organisation under which repository defined in
+#' parameter "repo" is hosted (default: KWB-R")
+#' @param branch default: NULL (i.e. use "default" branch) or user defined branch
+#' (e.g. "dev")
+#' @return generates Github Actions badges link
+#' @export
+use_badge_ghactions <- function(repo = NULL, user = "KWB-R", branch = NULL)
+{
+  sprintf("%s\n%s",
+          use_badge_ghactions_rcmdcheck(repo, user, branch),
+          use_badge_ghactions_pkgdown(repo, user, branch)
+          )
+  }
+
+
 # use_badge_codecov ------------------------------------------------------------
 
 #' Badge codecov
diff --git a/R/use_codecov.R b/R/use_codecov.R
@@ -6,7 +6,7 @@
 #' @export
 use_codecov <- function()
 {
-  usethis:::check_uses_travis()
+  usethis:::check_uses_github_actions()
   usethis:::use_dependency("covr", "Suggests")
 
   if (! usethis::use_template("codecov.yml", ignore = TRUE)) {
diff --git a/R/use_mit_license.R b/R/use_mit_license.R
@@ -16,7 +16,7 @@ use_mit_license <- function(
 {
   kwb.utils::catAndRun("Creating KWB MIT LICENSE/LICENSE.md files",
                        expr = {
-  usethis::use_mit_license(name = copyright_holder$name)})
+  usethis::use_mit_license(copyright_holder = copyright_holder$name)})
 
 
   copyright_years <- ifelse(!is.null(copyright_holder$start_year),
diff --git a/R/use_pkg.R b/R/use_pkg.R
@@ -65,22 +65,17 @@ use_pkg <- function(
   # Create PKGDOWN YML
   use_pkgdown(author, copyright_holder$name)
 
-  if (auto_build_pkgdown) {
-    use_autopkgdown(repo = pkg, org = user, dbg = dbg, ...)
-  } else {
-    # Create .travis.yml
-    use_travis()
-    # Create .gitlab-ci.yml for "main" branch with "docs" folder
-    fs::dir_create("docs")
-    use_gitlab_ci_docs()
-  }
-
-  # Create appveyor.yml
-  use_appveyor()
+  # Update Github Actions
+  use_ghactions()
 
   # Use codecov
   use_codecov()
 
+  if(auto_build_pkgdown) {
+  # Use GH actions for automating pkgdown deploy to "gh-pages" branch
+    use_autopkgdown(repo = pkg, org = user, dbg = dbg, ...)
+  }
+
   # Use index.Rmd (for pkgdown home:
   # see: https://pkgdown.r-lib.org/articles/pkgdown.html#home-page)
   use_index_md(user, domain, stage)
diff --git a/man/use_badge_ghactions.Rd b/man/use_badge_ghactions.Rd
diff --git a/man/use_badge_ghactions_pkgdown.Rd b/man/use_badge_ghactions_pkgdown.Rd
diff --git a/man/use_badge_ghactions_rcmdcheck.Rd b/man/use_badge_ghactions_rcmdcheck.Rd
diff --git a/tests/testthat/test-function-use_codecov.R b/tests/testthat/test-function-use_codecov.R
@@ -6,7 +6,7 @@ test_that("use_codecov() works", {
   withr::with_dir(create_pkg_temp(), {
   usethis::proj_set(getwd())
   kwb.pkgbuild::use_description()
-  kwb.pkgbuild:::use_travis() ## required
+  kwb.pkgbuild:::use_ghactions() ## required
   kwb.pkgbuild:::use_codecov()
  })
 })

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`#' @export`
`7`	`7`	`use_codecov <- function()`
`8`	`8`	`{`
`9`		`- usethis:::check_uses_travis()`
	`9`	`+ usethis:::check_uses_github_actions()`
`10`	`10`	`usethis:::use_dependency("covr", "Suggests")`
`11`	`11`
`12`	`12`	`if (! usethis::use_template("codecov.yml", ignore = TRUE)) {`