From 13a0ddec31119fe3f78d64b1a391530b29155916 Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Tue, 23 Apr 2024 14:26:55 -0400 Subject: [PATCH] Add a FAQ part in README and mention the git lfs feedback (closes #104) --- examples/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/examples/README.md b/examples/README.md index 9b7bf83..8cc09f7 100644 --- a/examples/README.md +++ b/examples/README.md @@ -16,3 +16,18 @@ - [R Manuals Quarto website](https://rstudio.github.io/r-manuals/) ([source](https://github.com/rstudio/r-manuals), [workflow file](https://github.com/rstudio/r-manuals/blob/main/.github/workflows/build-website.yaml)) This projects uses a workflow to build several books with R and Quarto and organizes them in a website deployed to Github pages. - [Pathology Atlas](https://www.patolojiatlasi.com/EN) ([source](https://github.com/patolojiatlasi/patolojiatlasi.github.io), [workflow file](https://github.com/patolojiatlasi/patolojiatlasi.github.io/blob/main/.github/workflows/Quarto-Render-Bilingual-Book-Push-Other-Repos-GitLab.yml)) This multilingual website is rendered in two versions and deployed using Github Actions. + +## FAQ + +* My project uses git lfs storage; how should I adapt the action? + + If your project uses git lfs storage, you must opt-in to git lfs during `checkout` step. + + ```yaml + - name: Check out repository + uses: actions/checkout@v4 + with: + lfs: true # needed when using lfs for image storage + ``` + + See the [checkout action documentation](https://github.com/actions/checkout) for details. \ No newline at end of file