r-lib / pkgdown

Generate static html documentation for an R package
https://pkgdown.r-lib.org/
Other
713 stars 333 forks source link

Error when building quarto articles on GH actions #2733

Open DanChaltiel opened 1 month ago

DanChaltiel commented 1 month ago

Hi,

I tried setting up quarto vignettes, and while it works perfectly on my computer (local), I could not manage to make it work on GH actions. Locally, even pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) works fine.

For instance, this is the last run I had: https://github.com/DanChaltiel/EDCimport/actions/runs/10092641396/job/27907083693#step:7:393 image Here is the workflow: https://github.com/DanChaltiel/EDCimport/actions/runs/10092641396/workflow I hope I did it correctly, but at least I can say that the error message is not specific enough to let me debug this. Note that my vignette uses tabsets.min.js to have tabs.

BTW, it would be nice to reference a minimal reproducible example in the vignette, so that we could simply grab the .qmd file, test that it runs on our setup, and then incrementally change our article it to make what we want.

hadley commented 1 month ago

@DanChaltiel could you please file the example rendering as a separate issue? For that it would be super useful if you could include a minimal qmd that illustrated the problem. Thanks!

DanChaltiel commented 1 month ago

I'm not sure what you meant, but I tried to add minimal vignettes to see which would fail. Here is the output: https://github.com/DanChaltiel/EDCimport/actions/runs/10107819848/job/27952452580#step:7:385 aaaaa_test_1.qmd is the exact copy of https://raw.githubusercontent.com/r-lib/pkgdown/main/vignettes/quarto.qmd and still fails.

I'd gladly give you more information but I'm a bit clueless on how to efficiently debug GHActions.

I separated the formula bug in the vignette into another issue as requested.

olivroy commented 1 month ago

@DanChaltiel You could try adding tinytex: true in the setup quarto action. You also no longer the pre-release version of Quarto. (They are starting veresion 1.6. It may (or may not) be unstable at the early stage.

Maybe try replacing this in https://github.com/DanChaltiel/EDCimport/blob/b7e63cced82bdaf00deb1fc8367c5c978faa8f5e/.github/workflows/pkgdown.yaml#L30-L35

      - uses: quarto-dev/quarto-actions/setup@v2
        with:
          tinytex: true
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DanChaltiel commented 1 month ago

Thanks, I tried it, but the error remains: https://github.com/DanChaltiel/EDCimport/actions/runs/10111494027/job/27963549942#step:7:392

olivroy commented 1 month ago

Ok, but I see that this is an article. (i.e. in the vignettes/articles folder as opposed to vignettes/) https://github.com/DanChaltiel/EDCimport/blob/main/vignettes/articles/adverse_events.qmd

If you want it to be a vignette, place it in the vignettes/ folder directly. If you want it to be an article, don't use the vignette declaration.

Use

---
title: "Adverse Events"
description: > 
  Learn how to make AE tables.
format: html
knitr:
  opts_chunk: 
    collapse: true
    comment: '#>'
---

Not sure if this will solve the issue, but it may help.

I have been able to setup Quarto articles in gt. https://github.com/rstudio/gt/blob/master/.github/workflows/pkgdown.yaml

DanChaltiel commented 1 month ago

@olivroy How dumb of me, that was the problem! Thank you very much :-)

@hadley feel free to close this issue, but maybe the error message could be a bit more helpful. There also could be a check that articles don't have a vignette declaration.