Expand the deploy_site_github() documentation to resolve r-lib#1206

lcolladotor · Feb 5, 2020 · f160903 · f160903
1 parent 48e12e0
commit f160903
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/R/deploy-site.R b/R/deploy-site.R
@@ -46,6 +46,10 @@
 #'    ```yaml
 #'    url: http://pkgdown.r-lib.org
 #'    ```
+#' * If needed, on your `.travis.yml` file, specify the `ssh_id` on your call
+#' to `deploy_site_github()`. For example,
+#' `ssh_id = Sys.getenv("TRAVIS_DEPLOY_KEY", "")`. Check the Travis logs to
+#' find the environment variable name used for storing the deployment ssh key.
 #'
 #' @inheritParams build_site
 #' @param install Optionally, opt-out of automatic installation. This is

diff --git a/man/deploy_site_github.Rd b/man/deploy_site_github.Rd