Build a bookdown book

do_bookdown() adds default steps related to package checks to the "install", "before_deploy", "script" and "deploy" stages.

1. step_install_deps() in the "install" stage

2. step_session_info() in the "install" stage.

3. step_setup_ssh() in the "before_deploy" to setup the upcoming deployment (if deploy is set),

4. step_setup_push_deploy() in the "before_deploy" stage (if deploy is set),

5. step_build_bookdown() in the "deploy" stage, forwarding all ... arguments.

6. step_do_push_deploy() in the "deploy" stage.

By default, the _book/ directory is deployed to the gh-pages branch, keeping the history.

Usage

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
)

Arguments

...

Passed on to step_build_bookdown()

deploy

[flag]
If TRUE, deployment setup is performed before building the bookdown site, and the site is deployed after building it. Set to FALSE to skip deployment. By default (if deploy is NULL), deployment happens if the following conditions are met:

1. The repo can be pushed to (see ci_can_push()).

2. The branch argument is NULL (i.e., if the deployment happens to the active branch), or the current branch is the default repo branch (usually "master") (see ci_get_branch()).

orphan

[flag]
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.

checkout

[flag]
Check out the current contents of the repository? Defaults to TRUE, set to FALSE if the build process relies on existing contents or if you deploy to a different branch.

path

[string]
Path to the repository, default "." which means setting up the current repository.

branch

[string]
Target branch, default: current branch.

remote_url

[string]
The URL of the remote Git repository to push to, defaults to the current GitHub repository.

commit_message

[string]
Commit message to use, defaults to a useful message linking to the CI build and avoiding recursive CI runs.

commit_paths

[character]
Restrict the set of directories and/or files added to Git before deploying. Default: deploy all files.

force

[logical]
Add --force flag to git commands?

private_key_name

string
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.

cname

(character(1)
An optional URL for redirecting the created website A CNAME file containing the given URL will be added to the root of the directory specified in argument path.

See also

Other macros: do_blogdown(), do_drat(), do_package_checks(), do_pkgdown(), do_readme_rmd(), list_macros()

Examples

if (FALSE) { # \dontrun{
dsl_init()

do_bookdown()

dsl_get()
} # }