From 5d1e149b5aaf6e4d7eb238575be8a30c9d7d3d68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 11 Jul 2025 11:30:14 +0200 Subject: [PATCH 1/4] document when pkgdown websites are re-built --- booknews.Rmd | 2 ++ pkg_ci.Rmd | 10 +++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/booknews.Rmd b/booknews.Rmd index ef5190610..ae17a4c8a 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-09, add a mention of ROR IDs (#909). - 2025-07-09, remove the upper-case from the NEWS.md template and update the real example link. (#896) diff --git a/pkg_ci.Rmd b/pkg_ci.Rmd index ff6257068..6b1e3416e 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/). Please report bugs, questions and feature requests about the central builds and about the template at [https://github.com/ropensci-org/rotemplate/](https://github.com/ropensci-org/rotemplate/). From e3572db987660f9e5221eef165b294f4c5882663 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 11 Jul 2025 12:04:18 +0200 Subject: [PATCH 2/4] es and pt translation --- pkg_ci.es.Rmd | 11 ++++++++++- pkg_ci.pt.Rmd | 10 +++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/pkg_ci.es.Rmd b/pkg_ci.es.Rmd index c25bea0fc..5b143e73f 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 nueva confirmación 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 63dfcac7e..107310682 100644 --- a/pkg_ci.pt.Rmd +++ b/pkg_ci.pt.Rmd @@ -100,7 +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á seu arquivo config do pkgdown, se você tiver um, exceto para o estilo que usará o pacote [ `rotemplate`](https://github.com/ropensci-org/rotemplate/). 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/). From 520db47861a1edd9c5df861010443d58dcd68489 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 15 Jul 2025 08:58:19 +0200 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Francesca Palmeira --- pkg_ci.pt.Rmd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg_ci.pt.Rmd b/pkg_ci.pt.Rmd index 107310682..c2f998d06 100644 --- a/pkg_ci.pt.Rmd +++ b/pkg_ci.pt.Rmd @@ -108,8 +108,8 @@ Após a transferência para a organização "ropensci" no GitHub pertencente a r - 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á seu arquivo config do pkgdown, se você tiver um, exceto para o estilo que usará o pacote [ `rotemplate`](https://github.com/ropensci-org/rotemplate/). +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/). -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/). From 8727f7ffd3f453e6565db316c668031c2f5711d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 19 Aug 2025 15:01:54 +0200 Subject: [PATCH 4/4] Update pkg_ci.es.Rmd Co-authored-by: Yanina Bellini Saibene --- pkg_ci.es.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg_ci.es.Rmd b/pkg_ci.es.Rmd index 5b143e73f..1eaf9d368 100644 --- a/pkg_ci.es.Rmd +++ b/pkg_ci.es.Rmd @@ -130,7 +130,7 @@ Para más detalles sobre este servicio, consulta [la página de ayuda de OpenCPU 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 nueva confirmación en la rama predeterminada (se comprueba aproximadamente una vez por hora). +- 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.