Provide pointer to GHA docs (#1351)

hadley · web-flow · commit e7f2c0b27ded · 2021-02-06T09:27:04.000-06:00
Fixes #1307
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)
 }

Original file line number	Diff line number	Diff line change
`@@ -143,8 +143,10 @@ use_github_action <- function(name,`
`143`	`143`	`url <- glue(`
`144`	`144`	`"https://raw.githubusercontent.com/r-lib/actions/master/examples/{name}"`
`145`	`145`	`)`
	`146`	`+ readme <- "https://github.com/r-lib/actions/blob/master/examples/README.md"`
`146`	`147`	`} else {`
`147`	`148`	`stopifnot(is_string(url))`
	`149`	`+ readme <- NULL`
`148`	`150`	`}`
`149`	`151`
`150`	`152`	`if (is.null(save_as)) {`
`@@ -163,6 +165,9 @@ use_github_action <- function(name,`
`163`	`165`	`if (open && new) {`
`164`	`166`	`edit_file(proj_path(save_as))`
`165`	`167`	`}`
	`168`	`+ if (!is.null(readme)) {`
	`169`	`+ ui_todo("Learn more at <{readme}>")`
	`170`	`+ }`
`166`	`171`
`167`	`172`	`invisible(new)`
`168`	`173`	`}`