Skip to content

Commit 59a210e

Browse files
maellefblpalmeirayabellini
authored
document when pkgdown websites are re-built (#937)
* document when pkgdown websites are re-built * es and pt translation * Apply suggestions from code review Co-authored-by: Francesca Palmeira <[email protected]> * Update pkg_ci.es.Rmd Co-authored-by: Yanina Bellini Saibene <[email protected]> * Update pkg_ci.pt.Rmd --------- Co-authored-by: Francesca Palmeira <[email protected]> Co-authored-by: Yanina Bellini Saibene <[email protected]>
1 parent 2099334 commit 59a210e

File tree

4 files changed

+30
-4
lines changed

4 files changed

+30
-4
lines changed

booknews.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## dev version
44

5+
- 2025-07-11, document better when the pkgdown websites of rOpenSci packages are re-built (#919).
6+
57
- 2025-07-11, add minimal mention of example datasets (#868).
68

79
- 2025-07-17, add category for rOpenSci internal and peer-review tools (#848).

pkg_ci.Rmd

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,15 @@ After transfer to rOpenSci's "ropensci" GitHub organization, each push to the re
115115

116116
## Even more CI: rOpenSci docs {#rodocsci}
117117

118-
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/).
118+
After transfer to rOpenSci's "ropensci" GitHub organization, a pkgdown website will be built for your package:
119+
120+
- For each new commit to the default branch (checked approx once per hour).
121+
122+
- When any of the strong dependencies in the same universe updates the version number.
123+
124+
- Once per month.
125+
126+
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/).
119127

120128
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.
121129

pkg_ci.es.Rmd

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,16 @@ Para más detalles sobre este servicio, consulta [la página de ayuda de OpenCPU
128128

129129
## Aún más servicios de CI: rOpenSci docs {#rodocsci}
130130

131-
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.
131+
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:
132+
133+
- Por cada nuevo _commit_ en la rama predeterminada (se comprueba aproximadamente una vez por hora).
134+
135+
- Cuando alguna de las dependencias fuertes del mismo universo actualiza el número de versión.
136+
137+
- Una vez al mes.
138+
139+
140+
132141
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).
133142
El sitio web estará en `https://docs.ropensci.org/package_name` (por ejemplo [para `magick`](https://docs.ropensci.org/magick)).
134143
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/).

pkg_ci.pt.Rmd

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,15 @@ Após a transferência para a organização "ropensci" no GitHub pertencente a r
100100

101101
## Ainda mais CI: documentos da rOpenSci {#rodocsci}
102102

103-
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/).
103+
Após a transferência para a organização "ropensci" no GitHub pertencente a rOpenSci, um site pkgdown será criado para o seu pacote:
104104

105+
- Para cada novo commit no ramo padrão (verificado aproximadamente uma vez por hora).
106+
107+
- Quando qualquer uma das dependências fortes no mesmo universo atualiza o número da versão.
108+
109+
- Uma vez por mês.
110+
111+
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/).
105112
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.
106113

107114
- 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:
120127
- `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)
121128
- Vignette, opção knitr eval: https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e
122129

123-
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/).
130+
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/).
124131

125132

0 commit comments

Comments
 (0)