From bf4813ce0bb18740ae0fa501f7d3a99746fbf651 Mon Sep 17 00:00:00 2001
From: Candace Savonen <cansav09@gmail.com>
Date: Wed, 8 Jan 2025 13:30:21 -0500
Subject: [PATCH] adding readability reports

---
 .github/workflows/pull_request.yml | 23 ++++++++++++++++++++++-
 config_automation.yml              |  2 ++
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
index 7f1e473d..950c9155 100644
--- a/.github/workflows/pull_request.yml
+++ b/.github/workflows/pull_request.yml
@@ -49,6 +49,7 @@ jobs:
       toggle_url_check: "${{ env.URL_CHECKER }}"
       toggle_quiz_check: "${{ env.CHECK_QUIZZES }}"
       toggle_md_linter: "${{ env.MARKDOWN_LINTER }}"
+      toggle_readability: "${{ env.READABILITY_REPORT }}"
       toggle_render_preview: "${{ env.RENDER_PREVIEW }}"
       rendering_docker_image: "${{ env.RENDERING_DOCKER_IMAGE }}"
 
@@ -129,7 +130,27 @@ jobs:
 
       - uses: DavidAnson/markdownlint-cli2-action@v19
         with:
-          globs: '*md$'
+          globs: '**/*.md'
+
+############################# 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 ###################################
 
diff --git a/config_automation.yml b/config_automation.yml
index 7aaabac1..bcbe6135 100644
--- a/config_automation.yml
+++ b/config_automation.yml
@@ -12,6 +12,8 @@ spell-check: yes
 style-code: yes
 # Would you like your markdown files to be checked for formatting
 markdown-linter: yes
+# Would you like a readability report on your markdowns?
+readability-report: yes
 # Test build the docker image if any docker-relevant files have been changed
 docker-test: no
 # Should URLs be tested periodically?