Build a bookdown bookSource:
do_bookdown() adds default steps related to package checks
"before_deploy"to setup the upcoming deployment (if
"deploy"stage, forwarding all
By default, the
_book/ directory is deployed
gh-pages branch, keeping the history.
do_bookdown( ..., deploy = NULL, orphan = FALSE, checkout = TRUE, path = "_book", 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 bookdown 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
NULL(i.e., if the deployment happens to the active branch), or the current branch is the default repo branch (usually "master") (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 to the repository, default
"."which means setting up the current repository.
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.
--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.
An optional URL for redirecting the created website A
CNAMEfile containing the given URL will be added to the root of the directory specified in argument