deploy_site
< Back to Reference | View source
deploy_site()
Deploy site to Pages branch
Usage
deploy_site(
pkg = ".",
branch = "pages",
remote = "origin",
build = TRUE,
commit_message = "Update documentation site"
)Arguments
| Argument | Description |
|---|---|
pkg |
Path to the package root directory |
branch |
The branch to deploy to. Defaults to “pages”. |
remote |
The git remote to push to. Defaults to “origin”. |
build |
Whether to rebuild the site before deploying. Defaults to TRUE. |
commit_message |
Commit message for the main branch. If NULL, skips committing. |
Value
Invisibly returns TRUE on success
Description
Builds the documentation site and deploys it to a pages branch using git subtree. This is a manual deployment method that works with both GitHub Pages and Codeberg Pages.
Examples
## Not run:
# Build and deploy
deploy_site()
# Deploy without rebuilding (if docs are already up to date)
deploy_site(build = FALSE)
## End(Not run)