Add a note about setting GH_TOKEN for TinyTeX API request

Author: cderv

examples/quarto-publish-example.yml

@@ -20,6 +20,8 @@ jobs:
 
       - name: Set up Quarto
         uses: quarto-dev/quarto-actions/setup@v2
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           # To install LaTeX to build PDF book 
           tinytex: true 

setup/README.md

@@ -35,10 +35,14 @@ We recommend using a Linux or MacOS runner if possible, especially if TinyTeX is
   ```yaml
     steps:
       - uses: quarto-dev/quarto-actions/setup@v2
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           tinytex: true
   ```
 
+  Setting `GH_TOKEN` is recommended as installing TinyTeX will query the github API. Otherwise, some API rate limit issue could happen which will make the step fails. A re-run of failed job on Github would solve it too.
+
 ### GitHub Enterprise
 
 For GitHub Enterprise Server (GHES), you may need to [generate a personal access token (PAT) on github.com](https://github.com/settings/tokens/new) to enable downloading Quarto. GitHub's [setup-python action](https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#avoiding-rate-limit-issues) uses a similar workaround, from which these instructions are adapted: