diff --git a/booknews.Rmd b/booknews.Rmd index 9a6b96d66..18233820b 100644 --- a/booknews.Rmd +++ b/booknews.Rmd @@ -2,6 +2,8 @@ ## dev version +- 2025-07-11, document better when the pkgdown websites of rOpenSci packages are re-built (#919). + - 2025-07-11, add minimal mention of example datasets (#868). - 2025-07-17, add category for rOpenSci internal and peer-review tools (#848). diff --git a/pkg_ci.Rmd b/pkg_ci.Rmd index 7c3bf9e81..aee787d38 100644 --- a/pkg_ci.Rmd +++ b/pkg_ci.Rmd @@ -115,7 +115,15 @@ After transfer to rOpenSci's "ropensci" GitHub organization, each push to the re ## Even more CI: rOpenSci docs {#rodocsci} -After transfer to rOpenSci's "ropensci" GitHub organization, a pkgdown website will be built for your package after each push to the GitHub repo. You can find the status of these builds at `https://ropensci.r-universe.dev/ui#packages` and in the [commit status](https://ropensci.org/blog/2021/09/03/runiverse-docs/#how-it-works). The website build will use your pkgdown config file if you have one, except for the styling that will use the [`rotemplate` package](https://github.com/ropensci-org/rotemplate/). +After transfer to rOpenSci's "ropensci" GitHub organization, a pkgdown website will be built for your package: + +- For each new commit to the default branch (checked approx once per hour). + +- When any of the strong dependencies in the same universe updates the version number. + +- Once per month. + +You can find the status of these builds at `https://ropensci.r-universe.dev/ui#packages` and in the [commit status](https://ropensci.org/blog/2021/09/03/runiverse-docs/#how-it-works). The website build will use your pkgdown config file if you have one, except for the styling that will use the [`rotemplate` package](https://github.com/ropensci-org/rotemplate/). If your documentation includes code that relies on, for instance, credentials, here's how to ensure pkgdown docs are rendered in the best possible way. diff --git a/pkg_ci.es.Rmd b/pkg_ci.es.Rmd index 99b0cde1f..dbc7b145d 100644 --- a/pkg_ci.es.Rmd +++ b/pkg_ci.es.Rmd @@ -128,7 +128,16 @@ Para más detalles sobre este servicio, consulta [la página de ayuda de OpenCPU ## Aún más servicios de CI: rOpenSci docs {#rodocsci} -Después de la transferencia a la organización GitHub "ropensci" de rOpenSci, cada *push* al repo de GitHub disparará la construcción (o actualización) del sitio web de tu paquete usando pkgdown. +Después de la transferencia a la organización GitHub "ropensci" de rOpenSci, cada *push* al repo de GitHub disparará la construcción (o actualización) del sitio web de tu paquete usando pkgdown: + +- Por cada nuevo _commit_ en la rama predeterminada (se comprueba aproximadamente una vez por hora). + +- Cuando alguna de las dependencias fuertes del mismo universo actualiza el número de versión. + +- Una vez al mes. + + + Puedes encontrar el estado de este proceso en la URL `https://ropensci.r-universe.dev/ui#packages` y en el [estado del commit](https://ropensci.org/blog/2021/09/03/runiverse-docs/#how-it-works). El sitio web estará en `https://docs.ropensci.org/package_name` (por ejemplo [para `magick`](https://docs.ropensci.org/magick)). Si tu paquete tiene un archivo de configuración de pkgdown, rOpenSci docs lo usará para crear el sitio web, excepto para el tema, que se utilizará [`rotemplate` paquete](https://github.com/ropensci-org/rotemplate/). diff --git a/pkg_ci.pt.Rmd b/pkg_ci.pt.Rmd index 1c22d0131..e76f81262 100644 --- a/pkg_ci.pt.Rmd +++ b/pkg_ci.pt.Rmd @@ -100,8 +100,15 @@ Após a transferência para a organização "ropensci" no GitHub pertencente a r ## Ainda mais CI: documentos da rOpenSci {#rodocsci} -Após a transferência para a organização "ropensci" no GitHub pertencente a rOpenSci, um site pkgdown será criado para o seu pacote após cada envio para o repositório no GitHub. Você pode encontrar o status dessas compilações em `https://ropensci.r-universe.dev/ui#packages` e na seção [status do commit](https://ropensci.org/blog/2021/09/03/runiverse-docs/#how-it-works). A compilação do site usará seu arquivo config do pkgdown, se você tiver um, exceto para o estilo que usará o pacote [ `rotemplate`](https://github.com/ropensci-org/rotemplate/). +Após a transferência para a organização "ropensci" no GitHub pertencente a rOpenSci, um site pkgdown será criado para o seu pacote: +- Para cada novo commit no ramo padrão (verificado aproximadamente uma vez por hora). + +- Quando qualquer uma das dependências fortes no mesmo universo atualiza o número da versão. + +- Uma vez por mês. + +Você pode encontrar o status dessas compilações em `https://ropensci.r-universe.dev/ui#packages` e na seção [status do commit](https://ropensci.org/blog/2021/09/03/runiverse-docs/#how-it-works). A compilação do site usará o seu arquivo config do pkgdown, se você tiver um, exceto para o estilo que usará o pacote [`rotemplate`](https://github.com/ropensci-org/rotemplate/). Se sua documentação incluir código que dependa, por exemplo, de credenciais, veja aqui como garantir que os documentos pkgdown sejam renderizados da melhor maneira possível. - Para exemplos de funções, use a tag roxygen2 `examplesIf` com a variável `IN_PKGDOWN`, por exemplo, `#' @examplesIf identical(Sys.getenv(“IN_PKGDOWN”), “true”)` @@ -120,6 +127,6 @@ Exemplos: - `examplesIf`:https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e935d4155570c5960d1fdb/R/get_service_info.R#L14 (veja também a documentação da tag roxygen2: https://roxygen2.r-lib.org/articles/rd.html?q=examplesIf#examples) - Vignette, opção knitr eval: https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e -Por favor, informe bugs, perguntas e solicitações de recursos sobre as compilações centrais e sobre o modelo em [https://github.com/ropensci-org/rotemplate/](https://github.com/ropensci-org/rotemplate/). +Por favor, informe bugs, faça perguntas e solicitações de recursos sobre as compilações centrais e sobre o modelo em [https://github.com/ropensci-org/rotemplate/](https://github.com/ropensci-org/rotemplate/).