Skip vignette rebuilds in R-CMD-check#15
Closed
Copilot wants to merge 2 commits into
Closed
Conversation
Copilot
AI
changed the title
[WIP] Fix R-CMD-check workflow to skip vignette building
Skip vignette rebuilds in R-CMD-check
Jun 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
R CMD checkwas failing because CI tried to rebuild vignettes that are intentionally committed asgithub_document-generated.mdoutputs, while check expects.html/.pdfartifacts from rebuilds. This updates the workflow to skip vignette building during check without weakening core package validation.R-CMD-check args update
argstor-lib/actions/check-r-packagein.github/workflows/R-CMD-check.yml.--no-build-vignettesalongside existing check flags to prevent vignette recompilation in CI.Behavioral impact
.Rmdfiles duringR CMD check.github_documentoutput and network-dependent vignette code paths.Original prompt
Fix R-CMD-check workflow to skip vignette building.
Current Issue
The R-CMD-check workflow is failing because it attempts to recompile vignettes, but the package uses
output: github_documentformat which generates.mdfiles instead of the.htmlor.pdffiles that R CMD CHECK expects.Solution
Add
--no-build-vignettesflag to the R CMD CHECK args in.github/workflows/R-CMD-check.yml. This will skip vignette building during the check while still validating the package structure.Change Details
File:
.github/workflows/R-CMD-check.ymlStep:
r-lib/actions/check-r-packageAdd a new
argsparameter:The pre-compiled
.mdvignettes are already in version control and use the github_document format which is friendly for git diffs. Skipping vignette building in CI allows the check to pass while maintaining this approach.The following is the prior conversation context from the user's chat exploration (may be truncated):
Assistant: Necesito crear una rama y PR. Déjame hacerlo con el coding agent:
Assistant: Estoy listo para crear un PR con la Opción 3. El cambio es simple y elegante:
Agregamos una variable de entorno
_R_CHECK_VIGNETTES_SKIP_RUN_: trueen el workflow que le dice a R CMD CHECK: "La vignettes están pre-compiladas, no intentes re-compilarlas".Esto:
✅ Mantiene
github_document(diffs más limpios en git)✅ Acepta los
.mdpre-compilados que ya están en el repo✅ Permite que R CMD CHECK siga validando la estructura del paquete
✅ Soluciona el fallo de PR #14
¿Procedo?
User: ya lo hice
Assistant: Este log es el antiguo (de 2026-06-02/03) - antes de tu fix. Déjame verificar si ya corriste el workflow nuevamente:
Assistant: Veo que los logs muestran el fallo anterior (antes de tu cambio). El workflow todavía está fallando porque aún intenta compilar las viñetas.
¿Ya pusheaste los cambios al PR? Espera a que se ejecute de nuevo. Si ya hiciste el cambio en
.github/workflows/R-CMD-check.yml, debería:_R_CHECK_VIGNETTES_SKIP_RUN_: trueen la secciónenv¿Puedes confirmar:
Si aún sigue fallando, te muestro la solución exacta.
User: revisa mis cambios
Assistant: ✅ Perfecto, tu cambio está correcto:
env: GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} R_KEEP_PKG_SOURCE: yes + _R_CHECK_VIGNETTES_SKIP_RUN_: truePero el log que viste es del run anterior (antes de tu cambio).
El run que está activo ahora en PR #14 debería estar usando tu cambio. Déjame verificar si ya pasó:
Assistant: ✅ Perfecto, tu cambio está bien hecho:
El archivo
.github/workflows/R-CMD-check.ymlya tiene el cambio. Pero veo que el run 26854962034 todavía dicefailure.Eso es porque ese run fue ANTES de tu cambio. El workflow se ejecutó con la versión antigua del archivo.
Necesitas que se ejecute de nuevo para que use la versión actualizada con tu fix. Las opciones:
git commit --allow-empty)¿Hiciste algún commit después del cambio al workflow, o fue el último cambio que committeaste?
User: @pfizer-opensource/Open-Hotgenes/pull/14
Assistant: Entiendo. Ese job que me diste es del run anterior (el que falló). Necesitas que se ejecute un nuevo run con tu cambio actualizado.
Opción rápida: Fuerza un re-run desde GitHub
O si prefieres hacerlo por CLI:
Eso ejecutará el workflow de nuevo con tu cambio del
_R_CHECK_VIGNETTES_SKIP_RUN_: trueincluido en el archivo.¿Ya lo hiciste o quieres que te ayude con otra cosa?
User: (r-reticulate) K29054NKJK:Open-Hotgenes virger$ gh run rerun 26854962034
bash: gh: command not found
Assistant: Necesitas instalar
gh(GitHub CLI). Pero hay una forma más fácil:Simplemente haz un commit vacío y push a tu rama del PR:
git commit --allow-empty -m "Trigger workflow re-run" git pushEso triggeará automáticamente el workflow con tu cambio del
_R_CHECK_VIGNETTES_SKIP_RUN_: true.O si prefieres la UI: Ve a https://github.com/pfizer-opensource/Open-Hotgenes/actions/runs/26854962034 y busca el botón "Re-run failed jobs" en la parte superior derecha.
¿Cuál prefieres?
User: que tal con los workflows?
Assistant: Excelente! ✅ Tu cambio funciona:
This pull request was created from Copilot chat.