updated gha instructions/workflows for quarto (#2757)

r-lib · Aug 16, 2024 · f4e653a · f4e653a
1 parent 1a6c8b7
commit f4e653a
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 30 deletions.
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -44,13 +44,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: quarto-dev/quarto-actions/setup@v2
-        with:
-          tinytex: true
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
       - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-tinytex@v2
 
       - uses: r-lib/actions/setup-r@v2
         with:

diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -21,11 +21,13 @@ jobs:
       - uses: r-lib/actions/setup-r@v2
         with:
           use-public-rspm: true
-
+      
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: any::lintr, local::.
           needs: lint
+
+      - uses: r-lib/actions/setup-tinytex@v2
 
       - name: Lint
         run: lintr::lint_package()

diff --git a/.github/workflows/netlify.yaml b/.github/workflows/netlify.yaml
@@ -16,11 +16,6 @@ jobs:
 
       - uses: r-lib/actions/setup-pandoc@v2
 
-      - name: Set up Quarto
-        uses: quarto-dev/quarto-actions/setup@v2
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
       - uses: r-lib/actions/setup-r@v2
         with:
           use-public-rspm: true

diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -26,12 +26,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: quarto-dev/quarto-actions/setup@v2
-        with:
-          tinytex: true
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
       - uses: r-lib/actions/setup-pandoc@v2
 
       - uses: r-lib/actions/setup-r@v2
@@ -42,6 +36,8 @@ jobs:
         with:
           extra-packages: any::pkgdown, local::.
           needs: website
+
+      - uses: r-lib/actions/setup-tinytex@v2
 
       - name: Build site
         run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)

diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -21,12 +21,6 @@ jobs:
 
       - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: quarto-dev/quarto-actions/setup@v2
-        with:
-          tinytex: true
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
       - uses: r-lib/actions/setup-r@v2
         with:
           use-public-rspm: true
@@ -35,6 +29,8 @@ jobs:
         with:
           extra-packages: any::covr, any::xml2
           needs: coverage
+
+      - uses: r-lib/actions/setup-tinytex@v2
 
       - name: Test coverage
         run: |

diff --git a/NEWS.md b/NEWS.md
@@ -5,6 +5,7 @@
 * New `clean_cache()` function removes the contents of the cache directory (#2718).
 
 * pkgdown now depends on R >= 4.0.0 (#2714)
+* Updated GitHub Actions advice and workflows around Quarto install (@tanho63, #2743)
 
 # pkgdown 2.1.0
 

diff --git a/vignettes/quarto.qmd b/vignettes/quarto.qmd
@@ -24,14 +24,10 @@ project:
   render: ['*.qmd']
 ```
 
-### GitHub actions
+### GitHub Actions
 
-Currently, you'll need to manually install Quarto in your GitHub actions. ([Hopefully this will change in the future](https://github.com/r-lib/actions/issues/866)). Add the following lines to install quarto:
+The `setup-r-dependencies` action will [automatically](https://github.com/r-lib/actions/tree/v2-branch/setup-r-dependencies#usage) install Quarto in your GitHub Actions if a .qmd file is present in your repository (see the `install-quarto` parameter for more details). 
 
-```yaml
-     - name: Set up Quarto
-       uses: quarto-dev/quarto-actions/setup@v2
-```
 
 ## Limitations