Set up GitHub actions for auto-building pkgdown site

diff --git a/.Rbuildignore b/.Rbuildignore
index 6128489067b39a39c9fa64278cf2a10e6d1a1687..0d5f2c3c8373700732017359c1794036033b90d1 100644 (file)
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -1,6 +1,10 @@
 ^\.git$
 ^\.gitattributes$
 ^\.gitignore$
 ^\.git$
 ^\.gitattributes$
 ^\.gitignore$

+^\.github$

 ^CITATION\.cff$
 ^LICENSE$
 ^README\.Rmd$
 ^CITATION\.cff$
 ^LICENSE$
 ^README\.Rmd$

+^docs$
+^pkgdown$
+^_pkgdown\.yml$

diff --git a/.github/.gitignore b/.github/.gitignore
new file mode 100644 (file)
index 0000000..2d19fc7
--- /dev/null
+++ b/.github/.gitignore
@@ -0,0 +1 @@
+*.html

diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644 (file)
index 0000000..4bbce75
--- /dev/null
+++ b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,50 @@
+# 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:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    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::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

diff --git a/.gitignore b/.gitignore
index 5f14eca87dad335b084d7992f86e4b66aa5eb239..678c87ac61e89714ed8225f320a1b7d336696c99 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,6 @@ inst/doc
 
 vignettes/*.html
 vignettes/*.R
 
 vignettes/*.html
 vignettes/*.R

+
+docs
+pkgdown

diff --git a/DESCRIPTION b/DESCRIPTION
index 774891e5bddc7ddb37122f36f5e6ff91d5fc4751..80b5a279f9482b574ca8cf5eb93a85810e37b7b8 100644 (file)
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -11,7 +11,7 @@ Description: A collection of methods for estimating the basic reproduction
     number (R0) of infectious diseases. Optionally available as a web
     application using the 'shiny' framework.
 License: AGPL (>= 3)
     number (R0) of infectious diseases. Optionally available as a web
     application using the 'shiny' framework.
 License: AGPL (>= 3)

-URL: https://github.com/MI2YorkU/Rnaught
+URL: https://MI2YorkU.github.io/Rnaught, https://github.com/MI2YorkU/Rnaught

 BugReports: https://github.com/MI2YorkU/Rnaught/issues
 Imports:
     stats,
 BugReports: https://github.com/MI2YorkU/Rnaught/issues
 Imports:
     stats,

diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644 (file)
index 0000000..57aae6b
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,3 @@
+url: https://MI2YorkU.github.io/Rnaught
+template:
+  bootstrap: 5