Deploy a pkgdown site on Travis-CI to Github PagesSource:
deploy_site_github() was designed to deploy your site from Travis CI,
which we no longer recommend, so this function is deprecated. There are
usethis::use_pkgdown_github_pages()will setup a GitHub action to automatically build and deploy your package website to GitHub pages.
deploy_to_branch()can be called locally to build and deploy your website to any desired branch.
deploy_site_github( pkg = ".", install = TRUE, tarball = Sys.getenv("PKG_TARBALL", ""), ssh_id = Sys.getenv("id_rsa", ""), commit_message = construct_commit_message(pkg), clean = FALSE, verbose = FALSE, host = "github.com", ..., repo_slug = Sys.getenv("TRAVIS_REPO_SLUG", "") )
Path to package.
Optionally, opt-out of automatic installation. This is necessary if the package you're documenting is a dependency of pkgdown
The location of the built package tarball. The default Travis configuration for R packages sets
PKG_TARBALLto this path.
The private id to use, a base64 encoded content of the private pem file. This should not be your personal private key. Instead create a new keypair specifically for deploying the site. The easiest way is to use
The commit message to be used for the commit.
Clean all files from old site.
Print verbose output
The GitHub host url.
Additional arguments passed to
user/reposlug for the repository.