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

Consider installing quarto by default? #866

Closed
hadley opened this issue Jun 12, 2024 · 8 comments · Fixed by #895
Closed

Consider installing quarto by default? #866

hadley opened this issue Jun 12, 2024 · 8 comments · Fixed by #895
Labels
feature a feature request or enhancement

Comments

@hadley
Copy link
Member

hadley commented Jun 12, 2024

For our package actions, we might want to consider installing quarto by default to make it easier for folks to use it for vignettes. Quarto bundles pandoc so we might be able to use it to replace the install pandoc step (quarto-dev/quarto-actions#107)

@hadley
Copy link
Member Author

hadley commented Jun 12, 2024

Or maybe automatically install it if the R quarto package is a dependency?

@olivroy
Copy link

olivroy commented Jul 8, 2024

This will help make this work more easily for usethis users r-lib/usethis#1997 (when the issue is fixed in usethis)

@hadley
Copy link
Member Author

hadley commented Jul 17, 2024

Or if it finds qmd files somewhere in the repo?

@gaborcsardi gaborcsardi added the feature a feature request or enhancement label Jul 17, 2024
@gaborcsardi
Copy link
Member

@cderv What do you think? How should this work?

@cderv
Copy link
Contributor

cderv commented Jul 17, 2024

How does it work for Pandoc today ? I believe we added recently the auto installation in setup-r-dependency. Are we happy with this compare to setting explicitly setup-pandoc action ?

Automatic is great, but it could also means more maintenance for you here depending on how you do it. AFAIK (and from personal experience) most of the users or r-lib/actions will use the usethis::use_github_action helpers to create there and have the necessary step. Adding in example used as template quarto-dev/quarto-actions/setup maybe sufficient.

However, it is not necessary to install it always, and it comes with a install cost. So doing it automatically on conditions is probably nicer experience, especially for R users not at ease with Github actions.

I would go with any .qmd found in the repo if possible. This would cover all cases, and not only packages project. However, looking at quarto R Package dependency is more targeted as anyone using vignettes would use it.

Less automated way could also be a first step, like installing install-quarto: true flag as setup-r-dependency configuration. This would also be a similar way for install-tinytex: true as Quarto allows to install TinyTeX from a single command, and we have that flag in quarto-actions/setup

Quarto bundles pandoc so we might be able to use it to replace the install pandoc step (quarto-dev/quarto-actions#107)

That seems a good way, I need to provide that output. This means though no pandoc version choice and using the one bundle.

@gaborcsardi
Copy link
Member

OK, so the plan is to add an input parameter called install-quarto, by default it will be 'auto' which means that if it is not already on the PATH, then we'll look for a .qmd file to check if we need to install it via the quarto setup action.

I'll also add a quarto-version parameter, to select the version to be installed.

@gaborcsardi
Copy link
Member

@cderv Now that I am writing this, it occured to me that we could do the same for pandoc, i.e. install it whenever there is an .Rmd file in the repo (within working-directory). Should we do that? Right now we auto-install it for R packages that depend on rmarkdown.

Copy link

This issue has been automatically locked. If you believe you have found a related problem, please file a new issue and include a link to this issue

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature a feature request or enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants