New repo issue addin

Author: phgrosjean

DESCRIPTION

@@ -11,7 +11,7 @@ Authors@R: c(
   email = "guyliann.engels@umons.ac.be"))
 Maintainer: Philippe Grosjean <phgrosjean@sciviews.org>
 Depends: R (>= 4.2.0)
-Imports: learnitdown
+Imports: learnitdown, gert, rstudioapi
 Suggests: 
     covr,
     knitr,

NAMESPACE

@@ -3,5 +3,8 @@
 export(config)
 export(obfuscator)
 export(sdd_info)
+export(sdd_repo_issue)
 export(sign_in)
 export(sign_out)
+importFrom(gert,git_remote_info)
+importFrom(utils,browseURL)

NEWS.md

@@ -2,6 +2,8 @@
 
 -   New version for academic year 2022-2023. New passwords.
 
+-   New addin "New repo issue", paired with function `sdd_repo_issue()` for easily creating a new issue in the currently edited repository.
+
 # BioDataScience 2022.1.0
 
 -   Course key changed to match Saturn Cloud workflow.

R/addins.R

@@ -1,5 +1,8 @@
 # RStudio addins
 
+sdd_repo_issue_addin <- function()
+  sdd_repo_issue()
+
 sdd_info_addin <- function()
   sdd_info()
 

R/sdd_repo_issue.R

@@ -0,0 +1,34 @@
+#' Create an issue in the current GitHub repository
+#'
+#' Use this function to quickly of a new issue in the repository that is
+#' currently edited in RStudio.
+#'
+#' @return Invisibly `TRUE` if it succeeds, or `FALSE`, e.g., no repository is
+#'   currently edited (and a warning is issued too).
+#' @export
+#' @importFrom gert git_remote_info
+#' @umportFrom rstudioapi showDialog
+#'
+#' @examples
+#' sdd_repo_issue()
+sdd_repo_issue <- function() {
+  repo_url <- try(gert::git_remote_info()$url, silent = TRUE)
+  if (inherits(repo_url, "try-error")) {
+    warning("Cannot get info about current GitHub repository (is one edited?)")
+    return(invisible(FALSE))
+  }
+  # Rework the URL if it is a git@github.com:... URL
+  repo_url <- sub("^git@github\\.com:", "https://github.com/", repo_url)
+  # Replace the end (.git) with "/issues/new"
+  repo_url <- sub("\\.git$", "/issues/new", repo_url)
+  # Display a message with short instructions + url
+  rstudioapi::showDialog(title = "Nouvelle issue sp\u00e9cifique au projet",
+    url = repo_url,
+    message = paste0(
+      "Cliquez sur le lien ci-dessous pour cr\u00e9er l'issue. ",
+      "Indiquez un titre et commencez le message par ",
+      "@BioDataScience-Course/teachers pour notifier ",
+      "imm\u00e9diatement vos enseignants de votre question. ",
+      "Ajoutez \u00e9ventuellement une capture d'\u00e9cran explicite."))
+  invisible(TRUE)
+}

inst/rstudio/addins.dcf

@@ -1,3 +1,8 @@
+Name: New repo issue
+Description: Create an issue in the current GitHub repository
+Binding: sdd_repo_issue_addin
+Interactive: false
+
 Name: SDD info
 Description: Get current SDD information
 Binding: sdd_info_addin