Add GitHub action to automatically render skeleton.Rmd when pull requests are made

.github/workflows/render-skeleton-rmd.yaml

@@ -0,0 +1,57 @@
+# Workflow derived from https://rfortherestofus.com/2023/05/github-actions
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  workflow_dispatch:
+  pull_request:
+    branches: [ master, main, develop ]
+
+name: render-skeleton-rmd
+
+jobs:
+  render-skeleton-rmd:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+
+      - name: Checkout VISCtemplates repo
+        uses: actions/checkout@v4
+
+      - name: Install pandoc
+        uses: r-lib/actions/setup-pandoc@v2
+
+      - name: Set up tinytex
+        uses: r-lib/actions/setup-tinytex@v2
+
+      - name: Set up R
+        uses: r-lib/actions/setup-r@v2
+
+      - name: Install R packages from VISCtemplates DESCRIPTION file and any others needed
+        uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          packages: |
+            any::remotes
+            any::devtools
+            any::conflicted
+            any::tidyverse
+
+      - name: Install VISCfunctions from GitHub
+        run: |
+          Rscript -e 'remotes::install_github("FredHutch/VISCfunctions")'
+
+      - name: Install VISCtemplates
+        run: |
+         Rscript -e 'devtools::install()'
+
+      - name: Render visc_empty skeleton.Rmd to all output formats
+        run: |
+          Rscript -e 'rmarkdown::render("inst/rmarkdown/templates/visc_empty/skeleton/skeleton.Rmd", output_format="all")'
+
+      - name: Upload visc_empty skeleton.docx and skeleton.pdf as GitHub action artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: visc-empty-skeleton-pdf-and-docx
+          path: |
+            inst/rmarkdown/templates/visc_empty/skeleton/skeleton.pdf
+            inst/rmarkdown/templates/visc_empty/skeleton/skeleton.docx

inst/rmarkdown/templates/visc_empty/skeleton/skeleton.Rmd

@@ -37,11 +37,11 @@ Location of input data:
 
 ```{r package-loading-and-options, include=FALSE}
 library(VISCtemplates)
+library(VISCfunctions)
 
 check_pandoc_version()
 
-packages_needed <- c("conflicted", "tidyverse", "knitr", "kableExtra", 
-                      "VISCfunctions")
+packages_needed <- c("conflicted", "tidyverse", "knitr", "kableExtra")
 
 install_load_cran_packages(packages_needed)
 
@@ -89,6 +89,11 @@ pandoc_markup <- set_pandoc_markup(output_type)
 
 # Section Header
 
+Add some text here
+
+## Subsection Header
+
+Add some text here
 
 `r insert_break()` 
 

inst/rmarkdown/templates/visc_report/skeleton/skeleton.Rmd

@@ -47,13 +47,11 @@ Location of input data:
 
 ```{r package-loading-and-options, include=FALSE}
 library(VISCtemplates)
+library(VISCfunctions)
 
 check_pandoc_version()
 
-packages_needed <- c(
-  "conflicted", "tidyverse", "knitr", "kableExtra", "VISCfunctions"
-  )
-
+packages_needed <- c("conflicted", "tidyverse", "knitr", "kableExtra")
 install_load_cran_packages(packages_needed)
 
 # knitr options