One file to rule them all

Updated build action, fixed empty file error on link checks and added a test file. Merge build, spell check and link check on one workflow, remove comments
pupil-labs · Dec 12, 2022 · b387b6d · b387b6d
1 parent d2d4a25
commit b387b6d
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 103 deletions.
diff --git a/.github/workflows/link-check-on-pr.yml → .github/workflows/PR-checks.yml b/.github/workflows/link-check-on-pr.yml → .github/workflows/PR-checks.yml
@@ -1,22 +1,16 @@
-name: 🌍 Links check on PR
-
-# This Action is designed to be used in a pull request (PR) workflow on GitHub. 
-# It uses the actions/checkout action to check out the PR branch and compare it with the base branch. 
-# Then, it uses the tj-actions/changed-files action to get a list of files that have been added or modified in the PR. 
-# This list is then passed to the lycheeverse/lychee-action action, which checks the files for broken links.
-# If the lychee-action step finds any broken links, a second job is triggered to test the broken links again,
-# this time using the URL of the branch on which the PR is based. 
-# This is done by getting the branch URL with a run step, then passing the broken URLs to lychee-action to test again 
-# with the new URL.
-# Overall, this Action is intended to help ensure that links in files added or modified in a PR do not lead to broken pages.
+name: on PR
+# This workflow is triggered on pull requests to the repository.
+# It runs a job to check for broken links in the files changed in the PR against the online built webpage, and against the files on the PR branch.
+# It checks for spelling errors in the files changed in the PR.
+# It builds the static site and checks the size of the built site.
 
 on:
   pull_request
 
 jobs:
   check_links_on_pr_files_online:
     runs-on: ubuntu-latest
-    name: Test changed-files for broken links
+    name: 🌍 Test changed-files for broken links
     outputs:
       lychee_exited: ${{ steps.stringify.outputs.lychee_exited }}
       lychee_file: ${{ steps.stringify.outputs.lychee_file }}
@@ -57,7 +51,7 @@ jobs:
       - name: 'Outputs as strings'
         id: stringify
         run: |
-          EXIT_CODE_STRING="$( printf '%d' "${{ steps.lychee.outputs.exit_code }}" )"
+          EXIT_CODE_STRING="$( printf '%d' "${{ env.lychee_exit_code }}" )"
           echo "lychee_exited=${EXIT_CODE_STRING}" >> $GITHUB_OUTPUT
           MD_OUT="$( cat ./lychee/results.md )"
           MD_OUT="${MD_OUT//'%'/'%25'}"
@@ -69,8 +63,9 @@ jobs:
           echo "lychee_file=${MD_OUT}" >> $GITHUB_OUTPUT
         
   check_failed_links_using_new_branch_url:
+    if: contains(['2'],${{ needs.check_links_on_pr_files_online.outputs.lychee_exited }})
     runs-on: ubuntu-latest
-    name: Test failed links using branch url
+    name: 🐙 Test failed links using branch url
     needs: check_links_on_pr_files_online
     outputs:
       lychee_exited_2: ${{ steps.stringify2.outputs.lychee_exited }}
@@ -80,19 +75,18 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: 'Check if outputs did propagate across jobs'
-        id: checks
-        run: |
-          echo ${{ needs.check_links_on_pr_files_online.outputs.lychee_exited }}
-          echo ${{ needs.check_links_on_pr_files_online.outputs.lychee_file }}
+      - uses: mdecoleman/[email protected]
+        id: branch_name
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: 'Get branch url'
         id: git-branch-name
         run: |
           url="https://github.com/"
           url+=${{github.repository}}
           url+="/tree/"
-          url+=${{github.ref}}
+          url+=${{steps.branch_name.outputs.branch}}
           url+="/src/"
           echo "branch_name=${url}" >> $GITHUB_OUTPUT
       
@@ -109,20 +103,22 @@ jobs:
           echo ${broken_urls} > temp/broken_urls.md
 
       - name: 'Test again these broken links with the new branch url'
-        id: final-links
+        id: lychee
         uses: lycheeverse/[email protected]
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
         with:
-          args: -v -n -a 403,503,429,200 -i -b '${{ steps.git-branch-name.outputs.branch_name }}' --exclude-mail --include-verbatim --'temp/broken_urls.md'
+          args: -v -n -a 403,503,429,200 -i -b '${{ steps.git-branch-name.outputs.branch_name }}' --exclude-mail --include-verbatim temp/broken_urls.md
           output: ./lychee/results_final.md
           jobSummary: true
 
       - name: 'Convert outputs to strings'
         id: stringify2
         run: |
-          EXIT_CODE_STRING="$( printf '%d' "${{ steps.final-links.outputs.exit_code }}" )"
+          EXIT_CODE_STRING="$( printf '%d' "${{  env.lychee_exit_code }}" )"
           echo "lychee_exited=${EXIT_CODE_STRING}" >> $GITHUB_OUTPUT
+          if [ ${{  env.lychee_exit_code }} -eq 2 ]
+          then
           MD_OUT="$( cat ./lychee/results_final.md )"
           MD_OUT="${MD_OUT//'%'/'%25'}"
           MD_OUT="${MD_OUT//$'\n'/'%0A'}"
@@ -131,30 +127,64 @@ jobs:
           echo "$MD_OUT" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
           echo "lychee_file=${MD_OUT}" >> $GITHUB_OUTPUT
+          else
+          echo "lychee_file=" >> $GITHUB_OUTPUT
+          fi
 
-  post_comment:
-    if: contains(['2'],${{ needs.check_failed_links_using_new_branch_url.outputs.lychee_exited_2}})
+  check_spelling:
+    name: ✍️ Check spelling
     runs-on: ubuntu-latest
-    name: Post comment
-    needs: [check_links_on_pr_files_online, check_failed_links_using_new_branch_url]
+    outputs:
+      fail_spelling: ${{ steps.fail.outputs.fail_spelling }}
     steps:
-      - id: get-comment-body
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+      - name: 'Check Grammar'
+        id: cspell
+        uses: streetsidesoftware/cspell-action@v2
+        with:
+          files: |
+            **/*.{md,html,ipynb}
+          strict: false
+          verbose: true
+
+      - name: 'Fail if spelling errors are found'
+        id: fail
+        if: steps.cspell.outputs.number_of_issues > 0
         run: |
-          body="$(echo "# Link check summary"; ${{ needs.check_failed_links_using_new_branch_url.outputs.lychee_file_2 }})"
-          body="${body//'%'/'%25'}"
-          body="${body//$'\n'/'%0A'}"
-          body="${body//$'\r'/'%0D'}" 
-          # echo "text<<EOF" >> $GITHUB_OUTPUT
-          # echo "$body" >> $GITHUB_OUTPUT
-          # echo "EOF" >> $GITHUB_OUTPUT
-          echo "::set-output name=body::$body" # the new output breaks format. See https://github.community/t/set-output-truncates-multiline-strings/16852/3
-          # echo "body=${body}" >> $GITHUB_OUTPUT
-          
-      - name: Create comment
-        uses: thollander/actions-comment-pull-request@v1
+          echo "fail_spelling="Spelling errors found" >> $GITHUB_OUTPUT
+          exit 1
+
+  build:
+    name: 📦 Build
+    runs-on: ubuntu-latest
+
+      - uses: actions/setup-python@v4
         with:
-          message: ${{ steps.get-comment-body.outputs.body }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Fail workflow if link broken
-        run: exit 1
+          python-version: '3.x'
+      - run: pip install nbconvert packaging
+      - name: Convert Jupyter notebooks
+        run: |
+          shopt -s globstar
+          jupyter-nbconvert --to markdown **/*.ipynb --ExtractOutputPreprocessor.enabled=False
+          shopt -u globstar
+        shell: bash
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install vuepress
+        run: yarn global add vuepress
+      - name: Install package.json
+        run: yarn
+      - name: Build static site with vuepress
+        # alias for vuepress build src defined in package.json
+        run: yarn build
+
+      - name: Get size of files in dist
+        shell: bash
+        run: |
+          du -ah src/.vuepress/dist
diff --git a/.github/workflows/build-only.yml b/.github/workflows/build-only.yml
@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - run: pip install nbconvert packaging
@@ -23,19 +23,19 @@ jobs:
         shell: bash
 
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: '12.x'
-      
+          node-version: 16
+
       - name: Install vuepress
         run: yarn global add vuepress
       - name: Install package.json
         run: yarn
       - name: Build static site with vuepress
         # alias for vuepress build src defined in package.json
         run: yarn build
-      
-      - name: Get size of files in dist 
+
+      - name: Get size of files in dist
         shell: bash
         run: |
           du -ah src/.vuepress/dist
diff --git a/.github/workflows/grammar-check.yml b/.github/workflows/grammar-check.yml
diff --git a/src/test.md b/src/test.md
@@ -0,0 +1,11 @@
+This is a test page.
+
+This is a broken link
+[Test](/this_page_does_not_exist)
+
+A link to this newly created page
+[Test](/test.md)
+
+And non-broken links
+[Home](/)
+[Google](https://google.com)