brainstorming
brainstorming
You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).
setup-github-actions-ciConfigurar GitHub Actions CI/CD para paquetes R, incluyendo R CMD check en múltiples plataformas, informes de cobertura de pruebas y despliegue del sitio pkgdown. Usa r-lib/actions para flujos de trabajo estándar. Usar al configurar CI/CD para un nuevo paquete R, añadir pruebas multiplataforma a un paquete existente, configurar el despliegue automático del …
Independent GitHub snapshot · Automated classification · Original documentation governs
Configurar R CMD check automatizado, cobertura de pruebas y despliegue de documentación mediante GitHub Actions.
Crear .github/workflows/R-CMD-check.yaml:
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
name: R-CMD-check
permissions: read-all
jobs:
R-CMD-check:
runs-on: ${{ matrix.config.os }}
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
strategy:
fail-fast: false
matrix:
config:
- {os: macos-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes
steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-pandoc@v2
- uses: r-lib/actions/setup-r@v2
with:
r-version: ${{ matrix.config.r }}
http-user-agent: ${{ matrix.config.http-user-agent }}
use-public-rspm: true
- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::rcmdcheck
needs: check
- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
build_args: 'c("--no-manual", "--compact-vignettes=gs+qpdf")'
Esperado: Archivo de flujo de trabajo .github/workflows/R-CMD-check.yaml creado con una matriz multiplataforma (macOS, Windows, Ubuntu) que cubre release, devel y oldrel.
En caso de fallo: Si el directorio .github/workflows/ no existe, crearlo con mkdir -p .github/workflows. Verificar la sintaxis YAML con un validador YAML.
Crear .github/workflows/test-coverage.yaml:
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
name: test-coverage
permissions: read-all
jobs:
test-coverage:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true
- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::covr, any::xml2
needs: coverage
- name: Test coverage
run: |
cov <- covr::package_coverage(
quiet = FALSE,
clean = FALSE,
install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
)
covr::to_cobertura(cov)
shell: Rscript {0}
- uses: codecov/codecov-action@v4
with:
fail_ci_if_error: ${{ github.event_name != 'pull_request' && true || false }}
file: ./cobertura.xml
plugin: noop
token: ${{ secrets.CODECOV_TOKEN }}
Esperado: Archivo de flujo de trabajo .github/workflows/test-coverage.yaml creado. Los informes de cobertura se subirán a Codecov en cada push y PR.
En caso de fallo: Si la subida a Codecov falla, verificar que el secreto CODECOV_TOKEN está configurado en los ajustes del repositorio. Para repositorios públicos, el token puede ser opcional.
Crear .github/workflows/pkgdown.yaml:
on:
push:
branches: [main, master]
release:
types: [published]
workflow_dispatch:
name: pkgdown
permissions:
contents: write
pages: write
jobs:
pkgdown:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-pandoc@v2
- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true
- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
needs: website
- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}
- name: Deploy to GitHub pages
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4
with:
clean: false
branch: gh-pages
folder: docs
Esperado: Archivo de flujo de trabajo .github/workflows/pkgdown.yaml creado. El sitio se compila y despliega en la rama gh-pages al hacer push a main o al publicar una versión.
En caso de fallo: Si el despliegue falla, asegurarse de que el repositorio tiene habilitados los permisos contents: write. Verificar que _pkgdown.yml tiene development: mode: release configurado.
Añadir a README.md:
[](https://github.com/USERNAME/REPO/actions/workflows/R-CMD-check.yaml)
Esperado: El README muestra una insignia de estado de CI activa que se actualiza automáticamente tras cada ejecución del flujo de trabajo.
En caso de fallo: Si la insignia muestra "no status", verificar que el nombre del archivo de flujo de trabajo en la URL de la insignia coincide con el archivo real. Hacer un push para activar la primera ejecución del flujo.
gh-pages si se usa pkgdownCODECOV_TOKEN si se usa informes de coberturaGITHUB_TOKEN tiene los permisos apropiadosEsperado: GitHub Pages está configurado para el despliegue de pkgdown. Los secretos requeridos están configurados. Los permisos del token son suficientes para los flujos de trabajo.
En caso de fallo: Si el despliegue de Pages falla, revisar Configuración > Pages para asegurarse de que la fuente está configurada en la rama gh-pages. Si faltan secretos, añadirlos en Configuración > Secretos y variables > Actions.
git add .github/
git commit -m "Add GitHub Actions CI workflows"
git push
Revisar la pestaña Actions en GitHub para verificar que los flujos de trabajo se ejecutan correctamente.
Esperado: Marcas de verificación verdes en todos los trabajos de la pestaña de GitHub Actions. Los flujos de trabajo se activan tanto en eventos de push como de PR.
En caso de fallo: Revisar los registros del flujo de trabajo en la pestaña Actions. Problemas frecuentes: dependencias de sistema faltantes (añadir a extra-packages), fallos en la compilación de viñetas (asegurarse de que el paso de configuración de pandoc está presente), errores de sintaxis YAML.
permissions: GitHub Actions ahora requiere permisos explícitos. Añadir permissions: read-all como mínimor-lib/actions/setup-r-dependencies que gestiona la mayoría de los casosr-lib/actions/setup-pandoc@v2_pkgdown.yml tiene development: mode: release para GitHub Pagesr-lib/actions/setup-r-dependencies gestiona la caché automáticamentecreate-r-package - configuración inicial del paquete incluyendo flujo de trabajo CIbuild-pkgdown-site - configuración detallada de pkgdownsubmit-to-cran - las verificaciones de CI deben reflejar las expectativas de CRANrelease-package-version - activar el despliegue al publicar una versión