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

Dependencies example does not show where to put the code #72

Open
jzadra opened this issue Mar 22, 2023 · 2 comments
Open

Dependencies example does not show where to put the code #72

jzadra opened this issue Mar 22, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@jzadra
Copy link

jzadra commented Mar 22, 2023

The dependencies example says to add

- uses: r-lib/actions/setup-r@v2
  with:
    r-version: '4.2.0' # The R version to download (if necessary) and use.

But it does not indicate where that code is supposed to go as far as indentation and parent. Does it go under jobs: built-deply: steps:? Or top level? More info is needed.

@jzadra
Copy link
Author

jzadra commented Mar 22, 2023

image

@cderv
Copy link
Collaborator

cderv commented Mar 22, 2023

But it does not indicate where that code is supposed to go as far as indentation and parent. Does it go under jobs: built-deply: steps:? Or top level? More info is needed.

e tried to help user by saying this in our doc: https://github.com/quarto-dev/quarto-actions/blob/main/examples/example-03-dependencies.md#installing-r

If you're using quarto-publish-example.yml, add those right after the # add software dependencies here comment.

- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
with:
# To install LaTeX to build PDF book
tinytex: true
# uncomment below and fill to pin a version
# version: SPECIFIC-QUARTO-VERSION-HERE
# add software dependencies here

This shows an example of where this should be added. Did you see that ? Was it not helpful example ?

I think we assume that users using the GitHub actions in there project will know about how to set an action and how other actions can be used (they can only be used as a step within a job)

We can definitely make more example if this is not helpful enough. PR are welcome too !

@cderv cderv added the documentation Improvements or additions to documentation label Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants