Crea un sitio en gh-pages mediante GitHub Actions — ros_actions_pkgdown

Instala un flujo de trabajo de GitHub Actions que genera el sitio pkgdown del paquete en la rama gh-pages del repositorio.

Uso

ros_actions_pkgdown_branch(pkg = ".", overwrite = TRUE)

Argumentos

pkg: Ruta a la raíz del paquete.
overwrite: Sobrescribe el flujo de trabajo si ya está instalado.

Valor

Devuelve NULL de forma invisible. Se llama por sus efectos secundarios.

Detalles

Para publicar el sitio en la carpeta docs en lugar de la rama gh-pages, usa ros_actions_pkgdown_docs().

Generación del sitio

Usa ros_build() para generar el sitio de forma local. Consulta pkgdown::build_site() para las opciones de generación.

Ver también

Flujos de trabajo de GitHub Actions: ros_actions_check_cron(), ros_actions_pkgdown_docs()

Sitios pkgdown: ros_actions_pkgdown_docs(), ros_build()

Ejemplos

pkg <- file.path(tempdir(), "pkgdown-branch")
if (!dir.exists(pkg)) {
  dir.create(pkg)
}
ros_actions_pkgdown_branch(pkg)
#> ✔ Adding "^docs$", "^_pkgdown\\.yml$", "^_pkgdown\\.yaml$", "^\\.github$", and
#>   "^pkgdown$" to /tmp/RtmpgGcQzZ/pkgdown-branch/.Rbuildignore.
#> ✔ Adding "*.html", "R-version", and "depends.Rds" to
#>   /tmp/RtmpgGcQzZ/pkgdown-branch/.github/.gitignore.
#> ✔ ¡Proceso completado!