Build pkgdown documentationSource:
do_pkgdown() builds and optionally deploys a pkgdown site and adds default
steps to the
"before_deploy"to setup the upcoming deployment (if
deployis set and only on GitHub Actions),
"deploy"stage, forwarding all
By default, the
docs/ directory is deployed to the
keeping the history.
do_pkgdown( ..., deploy = NULL, orphan = FALSE, checkout = TRUE, path = "docs", branch = "gh-pages", remote_url = NULL, commit_message = NULL, commit_paths = ".", force = FALSE, private_key_name = "TIC_DEPLOY_KEY" )
Passed on to
TRUE, deployment setup is performed before building the pkgdown site, and the site is deployed after building it. Set to
FALSEto skip deployment. By default (if
NULL), deployment happens if the following conditions are met:
The repo can be pushed to (see
ci_can_push()). account for old default "id_rsa"
NULL(i.e., if the deployment happens to the active branch), or the current branch is the default branch, or contains "cran-" in its name (for compatibility with fledge) (see
Create and force-push an orphan branch consisting of only one commit? This can be useful e.g. for
path = "docs", branch = "gh-pages", but cannot be applied for pushing to the current branch.
Check out the current contents of the repository? Defaults to
TRUE, set to
FALSEif the build process relies on existing contents or if you deploy to a different branch.
- path, branch
By default, this macro deploys the
docsdirectory to the
gh-pagesbranch. This is different from
The URL of the remote Git repository to push to, defaults to the current GitHub repository.
Commit message to use, defaults to a useful message linking to the CI build and avoiding recursive CI runs.
Restrict the set of directories and/or files added to Git before deploying. Default: deploy all files.
--forceflag to git commands?
Only needed when deploying from builds on GitHub Actions. If you have set a custom name for the private key during creation of the SSH key pair via tic::use_ghactions_deploy()] or
use_tic(), pass this name here.