Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to change verbosity in pkgdown GitHub actions #2844

Open
wiedenhoeft opened this issue Jan 23, 2025 · 9 comments
Open

How to change verbosity in pkgdown GitHub actions #2844

wiedenhoeft opened this issue Jan 23, 2025 · 9 comments
Labels

Comments

@wiedenhoeft
Copy link

wiedenhoeft commented Jan 23, 2025

For my repository (https://github.com/HUGLeipzig/kitesquare), I have followed https://r-pkgs.org/website.html to set up pkgdown with GitHub Actions in order to build a website at https://hugleipzig.github.io/kitesquare/. Everything appears to be in order. Yet for some reason, pkgdown fails the building step (https://github.com/HUGLeipzig/kitesquare/actions/runs/12929841229/job/36060042956):

Image

I can build the vignette locally with Quarto without problems. I am trying to figure out what is going wrong, and came across the suggestion in the log to

Rerun with quiet = FALSE to see the full error message.

Is it possible to pass quiet=FALSE from pkgdown::build_site_github_pages down to pkgdown:::build_quarto_articles somehow, or to change the verbosity level globally somehow?

@jayhesselberth
Copy link
Collaborator

Yeah, we don't pass quiet down from build_site() ... maybe we should.

Can you try simplifying your quarto header down to the minimum? wondering if something in your more complex header is causing the problem.

something like:

title: quarto vignettes
vignette: >
  %\VignetteIndexEntry{quarto vignettes}
  %\VignetteEngine{quarto::html}
  %\VignetteEncoding{UTF-8}

@wiedenhoeft
Copy link
Author

Thanks for the quick reply. I've tried with

---
title: Kite-Square Plots for Contingency Tables
echo: false
include: false
warning: false
error: false
message: false
vignette: >
  %\VignetteIndexEntry{quarto vignettes}
  %\VignetteEngine{quarto::html}
  %\VignetteEncoding{UTF-8}
---

but I get the same problem.

@wiedenhoeft
Copy link
Author

I also tried adding

quarto.quiet: false

to _pkgdown.yaml in order to emulate Quarto's

options(quarto.quiet = FALSE)

but to no effect.

@hadley
Copy link
Member

hadley commented Jan 23, 2025

It doesn't look like you install quarto in https://github.com/HUGLeipzig/kitesquare/blob/main/.github/workflows/pkgdown.yaml ?

@jayhesselberth
Copy link
Collaborator

jayhesselberth commented Jan 23, 2025

Quarto (the CLI) is indeed installed by the setup-r-dependencies rule in the GHA log above.

I was able to get a test quarto vignette to build in another package only after including quarto (the R library) in the website config portion of DESCRIPTION:

Config/Needs/website: quarto

@hadley We probably need to document that this step needs to be done in order for quarto vignettes to build? pkgdown itself is not affected because quarto is in Suggests. Alternatively, we could add quarto to pkgdown Imports so that it is always available. Thoughts?

@hadley
Copy link
Member

hadley commented Jan 23, 2025

Now that I think about it, quarto is supposed to auto-install if you use any .qmd files. But it's always the first thing I check 😄

@jayhesselberth
Copy link
Collaborator

Actaully, quarto in Suggests can't be the solution because it's in the kitesqaure package. But the Config strategy worked for me. Filed a PR at HUGLeipzig/kitesquare#1

HUG-ITO pushed a commit to HUGLeipzig/kitesquare that referenced this issue Jan 24, 2025
@wiedenhoeft
Copy link
Author

Thanks! Unfortunately, the error persists :-(

@jayhesselberth
Copy link
Collaborator

I would try running quarto build directly in GHA with the followin, which should print the error.

pkgdown:::build_quarto_articles(quiet=FALSE)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants