Added vignette on GHA

Author: VisruthSK

DESCRIPTION

@@ -4,14 +4,16 @@ Version: 2.0.1.9000
 Authors@R: 
     person("Visruth", "Srimath Kandali", , "public@visruth.com", role = c("aut", "cre"))
 Description: This package is a template package, built off of the Stan
-    Quarto styling. Exclusively for use styling `pkgdown` websites in
-    the Stan ecosystem.
+    Quarto styling. Exclusively for use styling `pkgdown` websites in the
+    Stan ecosystem.
 License: BSD_3_clause + file LICENSE
-URL: https://mc-stan.org/pkgdown-config, https://mc-stan.org/pkgdown-config
-Encoding: UTF-8
-Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.3
+URL: https://mc-stan.org/pkgdown-config,
+    https://mc-stan.org/pkgdown-config
 Suggests: 
     knitr,
     quarto
-VignetteBuilder: quarto
+VignetteBuilder: 
+    quarto
+Encoding: UTF-8
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.3

vignettes/GitHub Action.qmd

@@ -0,0 +1,71 @@
+---
+title: "GitHub Action"
+vignette: >
+  %\VignetteIndexEntry{Quirks}
+  %\VignetteEngine{quarto::html}
+  %\VignetteEncoding{UTF-8}
+knitr:
+  opts_chunk:
+    collapse: true
+    comment: '#>'
+---
+
+Here is a GitHub Action which can be used with the theme to automatically build the site.
+
+```yaml
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  # build dev site on merged pushes
+  push:
+    branches: [main, master]
+  # build full site on releases
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::., any::withr, stan-dev/pkgdown-config
+
+      - name: Build site
+        run: |
+          withr::with_envvar(
+            c("NOT_CRAN" = "true"), # this should already be set by setup-r@v2? keeping because vignettes don't build otherwise
+            pkgdown::build_site_github_pages(
+              lazy = FALSE, # change to TRUE if runner times out.
+              run_dont_run = TRUE,
+              new_process = TRUE
+            )
+          )
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
+```