do_blogdown() adds default steps related to package checks
step_install_deps() in the
"install" stage, using the
blogdown::install_hugo() in the
"install" stage to install the
latest version of HUGO.
step_session_info() in the
step_setup_ssh() in the
to setup the upcoming deployment (if
deploy is set),
step_setup_push_deploy() in the
deploy is set),
step_build_blogdown() in the
step_do_push_deploy() in the
By default, the
public/ directory is deployed to the
keeping the history. If the output directory of your blog/theme is not
"public" you need to change the
deploy = NULL,
orphan = FALSE,
checkout = TRUE,
repos = repo_default(),
path = "public",
branch = "gh-pages",
remote_url = NULL,
commit_message = NULL,
commit_paths = ".",
force = FALSE,
private_key_name = "TIC_DEPLOY_KEY",
cname = NULL
Passed on to
TRUE, deployment setup is performed
before building the blogdown 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
branch argument is
(i.e., if the deployment happens to the active branch),
or the current branch is the default repo branch
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
Path to the repository, default
"." which means setting up the current
Target branch, default: current branch.
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
An optional URL for redirecting the created
CNAME file containing the given URL will be added to the root
of the directory specified in argument