-
Notifications
You must be signed in to change notification settings - Fork 60
Update quarto-publish-example.yml #87
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added/suggested Julia action in addition to R since it is one of the main languages advertised in Quarto.
I also added the source of the actions for the documentation of those.
Seems to be a good addition since most users will have to add any of those actions to have computations (which is basically what offers Quarto).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am fine with adding them. However, let me explain why they are not currently:
Uncommenting these lines is not enough to make it work, as you need to configure the environment too to install the packages required by each of those language.
Like installing Python is not enough is you don't have jupyter install, and other used deps in your project.
To avoid maintaining a long file with all the cases possible, we documented the dependencies with links and example in the doc page (https://github.com/quarto-dev/quarto-actions/blob/main/examples/example-03-dependencies.md
), and mentioned in this YAML example only the reminder to add dependencies.
So I see two steps to improve this
-
Maybe add the link in this YAML workflow to https://github.com/quarto-dev/quarto-actions/blob/main/examples/example-03-dependencies.md
-
Add a workflow example for each language. Complete one that works out of the box.
Does that make sense ?
@cderv I like your idea much better It would result in less clutter also Let me close this PR |
In addition to language what about publishing target (netlify, GitHub pages etc? How do you think that is best handled for complete working examples? What we would have is Lang x Pub target so lots of combos Do you think the pub target should be commented ? |
I think we can add a link to the doc as a workflow user may not have read it yet.
Yes exactly. This is why we may need to document all this in a website way, and maybe using some clever feature to help users. Anyhow, this is part of a big overhaul to document quarto action better as part of the website I guess. Or at least create a small app with this idea above. |
Great idea about website tool! maybe we have a small app in shiny live that helps people construct a yaml? |
Yes exactly ! We need to make this small project comes live - timing constaint as often. Cool project though for anyone wanting to learn shinylive ! |
Co-authored-by: Mickaël Canouil <[email protected]>
Here is a basic shiny app that I'm hacking on |
All good thank ! I'll merge this with a minor tweak and we can then look closer to the shiny app and where to publicize it (probably on quarto-web) |
Add additional notes that I think might be helpful for people.