setup netlify workflow; fix #41

rapidsurveys · Jan 3, 2025 · 487e9fe · 487e9fe
1 parent da47b57
commit 487e9fe
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 8 deletions.
diff --git a/.github/workflows/netlify.yaml b/.github/workflows/netlify.yaml
@@ -0,0 +1,53 @@
+on:
+  pull_request:
+    branches: [main, master]
+
+name: pkgdown-pr
+
+jobs:
+  netlify:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-tinytex@v2
+
+      - 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: Install package
+        run: R CMD INSTALL .
+
+      - name: Create website
+        run: |
+          pkgdown::build_site()
+        shell: Rscript {0}
+
+      - name: Create index file
+        run: |
+          echo '<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0;URL=/dev/index.html" />  <script language="javascript"> window.location.replace('/dev/index.html')</script></head></html>' > ./docs/index.html
+
+      - name: Deploy to Netlify
+        uses: nwtgck/actions-netlify@v3.0
+        with:
+          publish-dir: './docs'
+          production-branch: main
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          deploy-message:
+            'Deploy from GHA: ${{ github.event.pull_request.title || github.event.head_commit.message }} (${{ github.sha }})'
+          # these default to 'true'
+          enable-commit-comment: false
+          enable-github-deployment: false
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -27,6 +27,6 @@ Encoding: UTF-8
 Language: en-GB
 LazyData: true
 RoxygenNote: 7.3.2
-Roxygeon: list(markdown = TRUE)
+Roxygen: list(markdown = TRUE)
 URL: https://rapidsurveys.io/okapi/,https://github.com/rapidsurveys/okapi
 BugReports: https://github.com/rapidsurveys/okapi/issues
diff --git a/README.Rmd b/README.Rmd
@@ -48,7 +48,9 @@ Currently, `{okapi}` provides functions to interface with [ONA](https://getodk.o
 ```{r install, echo = TRUE, eval = FALSE}
 install.packages(
   "okapi", 
-  repos = c('https://rapidsurveys.r-universe.dev', 'https://cloud.r-project.org')
+  repos = c(
+    'https://rapidsurveys.r-universe.dev', 'https://cloud.r-project.org'
+  )
 )
 ```
 

diff --git a/inst/CITATION b/inst/CITATION
@@ -4,7 +4,7 @@ bibentry(
   title    = "okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools",
   author   = person("Ernest Guevarra"),
   year     = "2024",
-  note     = "R package version 0.0.0.9000",
+  note     = "R package version 0.1.0.9000",
   url      = "https://rapidsurveys.io/okapi/",
   doi      = "10.5281/zenodo.206914853",
 )
diff --git a/man/ona_project_register.Rd b/man/ona_project_register.Rd
diff --git a/man/ona_project_share.Rd b/man/ona_project_share.Rd
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -18,7 +18,7 @@ navbar:
   type: light
   structure:
     left:  [home, intro, reference, articles, news]
-    right: [search, mastodon, github]
+    right: [search, mastodon, linkedin, github]
 
   components:
     # articles:
@@ -28,8 +28,12 @@ navbar:
     #     href: articles/haemoglobinaemia.html
     mastodon:
       icon: "fab fa-mastodon fa-lg"
-      href: https://fosstodon.org/@katilingban
       aria-label: Mastodon
+      href: https://fosstodon.org/@katilingban
+    linkedin:
+      icon: "fab fa-linkedin fa-lg"
+      aria-label: LinkedIn
+      href: https://www.linkedin.com/company/katilingban
 
 home:
   links: