Crea un sitio en /docs mediante GitHub Actions — ros_actions_pkgdown

Instala un flujo de trabajo de GitHub Actions que genera el sitio pkgdown del paquete en la carpeta docs del repositorio.

Uso

ros_actions_pkgdown_docs(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

El resultado final es equivalente a ejecutar ros_build(), pero este comando se ejecuta en GitHub, no localmente.

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

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_branch()

Sitios pkgdown: ros_actions_pkgdown_branch(), ros_build()

Ejemplos

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