Provide pointer to GHA docs (r-lib#1351)

Fixes r-lib#1307
dragosmg · Feb 6, 2021 · e7f2c0b · e7f2c0b
1 parent d2cf967
commit e7f2c0b
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/R/github-actions.R b/R/github-actions.R
@@ -143,8 +143,10 @@ use_github_action <- function(name,
     url <- glue(
       "https://raw.githubusercontent.com/r-lib/actions/master/examples/{name}"
     )
+    readme <- "https://github.com/r-lib/actions/blob/master/examples/README.md"
   } else {
     stopifnot(is_string(url))
+    readme <- NULL
   }
 
   if (is.null(save_as)) {
@@ -163,6 +165,9 @@ use_github_action <- function(name,
   if (open && new) {
     edit_file(proj_path(save_as))
   }
+  if (!is.null(readme)) {
+    ui_todo("Learn more at <{readme}>")
+  }
 
   invisible(new)
 }