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

Trouble setting Quarto CI up #79

Closed
kellertuer opened this issue May 27, 2023 · 9 comments · May be fixed by #81
Closed

Trouble setting Quarto CI up #79

kellertuer opened this issue May 27, 2023 · 9 comments · May be fixed by #81

Comments

@kellertuer
Copy link

I am trying to render my Julia Tutorials written in Quarto in CI to not commit the Markdown files longer.

But besides not knowing whether quarto brings Python/Jupyter with itself or I have to install that as well on CI (net yet sure how), it for now does not find the folder.

The repository is this

https://github.com/JuliaManifolds/Manopt.jl/tree/kellertuer/quarto-ci

the tutorials are in the tutorials/ folder (also the quarto config), but neither with not without trailing / that folder seems to be found with

https://github.com/JuliaManifolds/Manopt.jl/blob/98950441c56da211cbc26dfeb803e76546264ec9/.github/workflows/documenter.yml#L12-L21

see

https://github.com/JuliaManifolds/Manopt.jl/actions/runs/5098182999/jobs/9165174924#step:4:1

So I am not sure how I would correctly specify that I wan to render all files in that folder?

@cderv
Copy link
Collaborator

cderv commented May 30, 2023

But besides not knowing whether quarto brings Python/Jupyter with itself or I have to install that as well on CI (net yet sure how)

Quarto does not come with R, nor Python, Julia or Jupyter. You need to set up by yourself.

We did not make it part of the action itself to not install by default for all because it depends on each project. Some use Conda, or other python installation.

You can use any Github actions in market place that can help you with this, or install with your own command.

We give some examples in our doc: https://quarto.org/docs/publishing/github-pages.html#executing-code

We can probably add some examples of workflow in this repo though to help 🤔 Thanks for the feedback !

So I am not sure how I would correctly specify that I wan to render all files in that folder?

You did not checkout your repository. So on the github action runner, there is no file to render.

We should the step in the YAML example: https://github.com/quarto-dev/quarto-actions/blob/main/examples/quarto-publish-example.yml or in our doc like https://quarto.org/docs/publishing/github-pages.html#executing-code

but this is also basic Github action step, so you'll find some information on Github action own documentation https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#understanding-the-workflow-file

Hope it helps

@kellertuer
Copy link
Author

I already noticed the missing checkout as well (stupid me), and I now moved to doing python dependencies with CondaPkg since I feel most comfortable with Julia stuff (and got some great help at the Julia Slack). So maybe my Julia-Quarto-Documenter-jl can serve as one example as well.

@cderv
Copy link
Collaborator

cderv commented May 30, 2023

Awesome!

So maybe my Julia-Quarto-Documenter-jl can serve as one example as well.

Yes definitely !

@kellertuer
Copy link
Author

Current status: The Julia started within Python/Jupyter that is started from a quarto call from within Julia (nooo, not a long route) complains still, but I am getting there ;)

@kellertuer
Copy link
Author

The current state of GH Actions and the docs/make.jl actually do the job JuliaManifolds/Manopt.jl#254 – though that might be simplified maybe (I am not that much an GH expert).
I could write a short post about that somewhere (just that I myself do not have a blog or so).

@cderv
Copy link
Collaborator

cderv commented May 31, 2023

Cool !

I could write a short post about that somewhere (just that I myself do not have a blog or so).

We have the example folder here: https://github.com/quarto-dev/quarto-actions/tree/main/examples

You could add to README your repo so show an example, or we could add a .md in the folder to show an example with Julia project. What do you think ? PR welcome !

@kellertuer
Copy link
Author

I could write the idea and setup with code parts and link to the concrete example at the end maybe?

But and example in that folder sounds like a good idea.

@cderv
Copy link
Collaborator

cderv commented May 31, 2023

Do as you think is the easiest for you. Personally I think

  • Short text with links to somewhere else are good for the README of that folder
  • Detailed example with code example are good as a standalone .md file in that folder
  • Adding additionally a full example .yaml workflow for Julia user is definitely an option too!

@kellertuer
Copy link
Author

The PR of how to do this is open for a while so this is basically resolved.

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

Successfully merging a pull request may close this issue.

2 participants