Skip to contents

projr_build_output Builds project to output, which means recording the input and output data hashes, building the actual bookdown document and saving and archiving selected output.

projr_build_major, projr_build_minor and projr_build_patch are wrappers around projr_build_output with the version component bumped set automatically, e.g. projr_build_major() is equivalent projr_build_output(bump_component = "major").

Usage

projr_build_output(
  bump_component,
  msg = NULL,
  args_engine = list(),
  profile = NULL
)

projr_build_major(msg = NULL, args_engine = list(), profile = NULL)

projr_build_minor(msg = NULL, args_engine = list(), profile = NULL)

projr_build_patch(msg = NULL, args_engine = list(), profile = NULL)

Arguments

bump_component

"major", "minor", "patch" or missing. Specifies version component to increment. If missing, then is set equal to the lowest version component in used version format. No default (i.e. is missing by default).

msg

character. Message to append to Git commit messages. Default is NULL, in which case the user is prompted for a message or, if the session is not interactive, it is left empty. Default is NULL. Note that the Git messages in this case would not be blank - they would simply consist of details as to the version being bumped to and the stage in the build process at which the commit was made.

args_engine

list. Arguments passed to the rendering engine (rmarkdown::render, quarto::render or bookdown::render_book).

profile

character. projr profile to use. Will set the environment variable PROJR_PROFILE to this value at the start of the build,