Merge pull request #4 from fhdsl/cansavvy-patch-2

Add readability report

.github/workflows/pull_request.yml

@@ -46,6 +46,7 @@ jobs:
       toggle_url_check: "${{ env.URL_CHECKER }}"
       toggle_render_preview: "${{ env.RENDER_PREVIEW }}"
       rendering_docker_image: "${{ env.RENDERING_DOCKER_IMAGE }}"
+      toggle_readability: "${{ env.READABILITY_REPORT }}"
 
 ########################## Make the error reports ##############################
   spell-check:
@@ -69,7 +70,28 @@ jobs:
       error_min: 0
     secrets:
       gh_pat: ${{ secrets.GH_PAT }}
+
+############################# Readability Report ###################################
 
+  readability-report:
+    name: Readability report
+    needs: yaml-check
+    runs-on: ubuntu-latest
+    if: ${{needs.yaml-check.outputs.toggle_readability == 'yes'}}
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Readability report
+        uses: Rebilly/lexi@v2
+        with:
+          github-token: ${{ secrets.GH_PAT }}
+          glob: '**/*.md'
+ ############################# Render preview ###################################
+
   render-preview:
     name: Render preview
     needs: yaml-check

config_automation.yml

@@ -13,6 +13,8 @@ style-code: yes
 # Test build the docker image if any docker-relevant files have been changed
 # Should URLs be tested periodically?
 url-check-periodically: yes
+# Would you like a readability report on your markdowns?
+readability-report: yes
 
 # What docker image should be used for rendering?
 # The default is jhudsl/base_ottr:main

resources/exclude_files.txt

@@ -0,0 +1,8 @@
+About.Rmd
+docs/*
+style-sets/*
+manuscript/*
+CONTRIBUTING.md
+LICENSE.md
+code_of_conduct.md
+README.md