quarto-dev / quarto-actions

GNU General Public License v2.0
228 stars 53 forks source link

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

Open jzadra opened 1 year ago

jzadra commented 1 year ago

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 commented 1 year ago

image

cderv commented 1 year ago

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.

https://github.com/quarto-dev/quarto-actions/blob/428de7a75c7ae7ceac6eac3f03ba519004c02027/examples/quarto-publish-example.yml#L14-L22

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 !