search

quarto-dev / quarto-actions

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

Update example with lfs #104

Closed bevsxyz closed 6 months ago

bevsxyz commented 7 months ago

Github doesn't load lfs tracked files unless mentioned in the actions explicitely

bevsxyz commented 7 months ago

I got the help from https://discourse.gohugo.io/t/github-pages-git-lfs/34217/3

I think we will also need to update the documentations

cderv commented 7 months ago

Hi, thanks for your contribution

Git LFS is quite specific and advanced usage IMO. I am not sure this is a good idea to set this by default in the example, as it could lead to confusion about "is LFS needed with Quarto ?".

The configuration about lfs: true is related to configuration available for actions/checkout and it should be documented there. We may add a comment though using LFS with Quarto is possible: Do you have an example repo to share ?

Thank you

bevsxyz commented 7 months ago

The code for my website is private ATM. I'll see if I can whip up another repo for example. But basically, if you intend to use git lfs and have already configured it, then without that flag the images won't be copied to gh-pages. I had git-lfs already present before transitioning from hugo. So it was frustrating as to why images weren't loading through ci.

cderv commented 7 months ago

Oh sure I understand that it could be private. I understand why it could puzzling when you don't know this configuration from actions/checkout. I'll see where I can add a note to this. I don't think we should set the default to TRUE for this setting as it is not the default in the original action.

bevsxyz commented 6 months ago

@cderv we can set it to false with a comment

cderv commented 6 months ago

I added a mention in the README about this, as a FAQ question.

Thanks for the feedback.