Skip to content

Commit 13a0dde

Browse files
committed
Add a FAQ part in README
and mention the git lfs feedback (closes #104)
1 parent 5a5a0c0 commit 13a0dde

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

examples/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,18 @@
1616
- [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.
1717

1818
- [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.
19+
20+
## FAQ
21+
22+
* My project uses git lfs storage; how should I adapt the action?
23+
24+
If your project uses git lfs storage, you must opt-in to git lfs during `checkout` step.
25+
26+
```yaml
27+
- name: Check out repository
28+
uses: actions/checkout@v4
29+
with:
30+
lfs: true # needed when using lfs for image storage
31+
```
32+
33+
See the [checkout action documentation](https://github.com/actions/checkout) for details.

0 commit comments

Comments
 (0)