Figuring out better system for downloading spell check file

.github/workflows/render-preview.yml

@@ -17,20 +17,29 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: checkout
+      - name: Checkout files
         uses: actions/checkout@v2
 
-      # We want a fresh run of the renders each time
-      - name: Delete old docs/*
-        run: |
-          rm -r docs/*
-
       # Set up git checkout
       - name: Set up git checkout
         run: |
-          git checkout -b "preview-${{ github.event.pull_request.number }}"
-          git config --local user.email "actions@github.com"
-          git config --local user.name "GitHub Actions"
+          git config --local user.email "itcrtrainingnetwork@gmail.com"
+          git config --local user.name "jhudsl-robot"
+          git config pull.rebase false
+
+          # Get on the preview branch if it exists. If it doesn't create it.
+          branch_name='preview-${{ github.event.pull_request.number }}'
+          git rev-parse --quiet --verify $branch_name >/dev/null && exists=true || exists=false
+
+          if [[ $exists == true ]];
+          then
+            git checkout $branch_name
+            git pull --set-upstream origin $branch_name --allow-unrelated-histories
+          else
+            git checkout -b $branch_name
+          fi
+
+          rm -r docs/*
 
       # Run bookdown rendering
       - name: Run bookdown render
@@ -63,7 +72,7 @@ jobs:
           exit 1
 
       # Commit the rendered bookdown files
-      - name: Commit rendered bookdown files to development branch
+      - name: Commit rendered bookdown files to preview branch
         id: commit
         run: |
           changes=$(git diff --name-only `git log --format="%H" -n 1 origin/main` -- docs)
@@ -72,7 +81,8 @@ jobs:
             echo ::set-output name=changes::$(echo 'changes')
             git add . --force
             git commit -m 'Render bookdown preview'
-            git push --force origin "preview-${{ github.event.pull_request.number }}"
+            git pull --set-upstream origin "preview-${{ github.event.pull_request.number }}" --allow-unrelated-histories
+            git push --force --set-upstream origin "preview-${{ github.event.pull_request.number }}"
           else
             echo ::set-output name=changes::$(echo 'no_changes')
           fi

.github/workflows/style-and-sp-check.yml

@@ -20,7 +20,7 @@ jobs:
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      - name: checkout repo
+      - name: Checkout files
         uses: actions/checkout@v2
 
       - name: login as jhudsl-robot
@@ -33,22 +33,42 @@ jobs:
         run: |
           results=$(Rscript "scripts/spell-check.R")
           echo "::set-output name=sp_chk_results::$results"
-          cat spell_check_results.tsv
+          cat resources/spell_check_results.tsv
 
       - name: Archive spelling errors
         uses: actions/upload-artifact@v2
         with:
           name: spell-check-results
-          path: spell_check_results.tsv
+          path: resources/spell_check_results.tsv
+
+      - name: Spell check errors
+        run: |
+          # Get on the preview branch if it exists. If it doesn't create it.
+          branch_name='preview-${{ github.event.pull_request.number }}'
+          git rev-parse --quiet --verify $branch_name >/dev/null && exists=true || exists=false
+
+          if [[ $exists == true ]];
+          then
+            git checkout $branch_name
+            git pull --set-upstream origin $branch_name --allow-unrelated-histories
+          else
+            git checkout -b $branch_name
+          fi
+
+          git add --force resources/spell_check_results.tsv
+          git commit -m 'Add spell check file'
+          git push --force --set-upstream origin $branch_name
 
       - name: Build components of the spell check comment
         id: build-components
         env:
           GH_PAT: ${{ secrets.GH_PAT }}
         run: |
+          branch_name='preview-${{ github.event.pull_request.number }}'
+          sp_error_url=https://raw.githubusercontent.com/${GITHUB_REPOSITORY}/$branch_name/resources/spell_check_results.tsv
           echo ::set-output name=time::$(date +'%Y-%m-%d')
           echo ::set-output name=commit_id::$GITHUB_SHA
-          echo ::set-output name=sp_error_url::$(Rscript --vanilla scripts/get_spell_errors.R --repo "$GITHUB_REPOSITORY" --git_pat "$GH_PAT")
+          echo ::set-output name=sp_error_url::$sp_error_url
 
       # Handle the commenting
       - name: Find Comment
@@ -91,8 +111,9 @@ jobs:
       - name: Run styler
         run: Rscript -e "styler::style_file(list.files(pattern = 'Rmd$', recursive = TRUE, full.names = TRUE));warnings()"
 
-      - name: Commit
+      - name: Commit styled files
         run: |
           git add \*.Rmd
+          git add resources/spell_check_results.tsv
           git commit -m 'Style Rmds' || echo "No changes to commit"
           git push origin || echo "No changes to commit"

docs/About.md

@@ -51,7 +51,7 @@ These credits are based on our [course contributors table guidelines](https://gi
 ##  collate  en_US.UTF-8                 
 ##  ctype    en_US.UTF-8                 
 ##  tz       Etc/UTC                     
-##  date     2022-01-06                  
+##  date     2022-01-13                  
 ## 
 ## ─ Packages ───────────────────────────────────────────────────────────────────
 ##  package     * version    date       lib source                            

docs/about-the-authors.html

@@ -357,7 +357,7 @@ <h1>About the Authors</h1>
 ##  collate  en_US.UTF-8                 
 ##  ctype    en_US.UTF-8                 
 ##  tz       Etc/UTC                     
-##  date     2022-01-06                  
+##  date     2022-01-13                  
 ## 
 ## ─ Packages ───────────────────────────────────────────────────────────────────
 ##  package     * version    date       lib source                            

docs/coursera/About.md

@@ -51,7 +51,7 @@ These credits are based on our [course contributors table guidelines](https://gi
 ##  collate  en_US.UTF-8                 
 ##  ctype    en_US.UTF-8                 
 ##  tz       Etc/UTC                     
-##  date     2022-01-06                  
+##  date     2022-01-13                  
 ## 
 ## ─ Packages ───────────────────────────────────────────────────────────────────
 ##  package     * version    date       lib source                            

docs/coursera/about-the-authors.html

@@ -357,7 +357,7 @@ <h1>About the Authors</h1>
 ##  collate  en_US.UTF-8                 
 ##  ctype    en_US.UTF-8                 
 ##  tz       Etc/UTC                     
-##  date     2022-01-06                  
+##  date     2022-01-13                  
 ## 
 ## ─ Packages ───────────────────────────────────────────────────────────────────
 ##  package     * version    date       lib source                            

resources/dictionary.txt

@@ -3,17 +3,20 @@ BIPOC
 Bloomberg
 Datatrail
 DataTrail
+dropdown
 GDSCN
 impactful
 ITCR
 itcrtraining
 ITN
+fyi
 Leanpub
 Markua
 mentorship
 NCI
 NHGRI
 UE
 UE5
+reproducibility
 underserved
 www

scripts/spell-check.R

@@ -33,5 +33,9 @@ sp_errors <- spelling::spell_check_files(files, ignore = dictionary) %>%
 # Print out how many spell check errors
 write(nrow(sp_errors), stdout())
 
+if (!dir.exists("resources")) {
+  dir.create("resources")
+}
+
 # Save spell errors to file temporarily
-readr::write_tsv(sp_errors, 'spell_check_results.tsv')
+readr::write_tsv(sp_errors, file.path('resources', 'spell_check_results.tsv'))