do_pkgdown() builds and optionally deploys a pkgdown site and adds default
steps to the
step_install_deps() in the
"install" stage, using the
step_session_info() in the
step_setup_ssh() in the
"before_deploy" to setup
the upcoming deployment (if
deploy is set and only on
step_setup_push_deploy() in the
deploy is set),
step_build_pkgdown() in the
step_do_push_deploy() in the
By default, the
docs/ directory is deployed to the
keeping the history.
deploy = NULL,
orphan = FALSE,
checkout = TRUE,
repos = repo_default(),
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.
FALSE to skip deployment.
By default (if
NULL), deployment happens
if the following conditions are met:
The repo can be pushed to (see
account for old default "id_rsa"
branch argument is
(i.e., if the deployment happens to the active branch),
or the current branch is thge default branch (usually "master")
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
FALSE if the build process relies on existing contents or
if you deploy to a different branch.
CRAN-like repositories to install from, defaults to
By default, this macro deploys the
gh-pages branch. 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.
--force flag 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