workin

Author: timothymcmackin

.github/workflows/test-pr.yml

@@ -6,14 +6,19 @@ on:
     types: [opened, reopened, synchronize]
 
 env:
+  # The folder with the doc files
+  DOCS_FOLDER: 'docs'
   # The folder that Docusaurus hosts static files (images) from
   STATIC_FOLDER: 'static'
   # Images to ignore for image use checks
   IGNORE_IMAGES: 'img/site'
+  # The folder that the tests repo is cloned to
+  TEST_REPO: 'doclib'
 
 jobs:
 
   # Get files that are added or changed in this PR
+  # Provides the files as a comma-separated list
   getChangedFiles:
     runs-on: ubuntu-latest
     outputs:
@@ -29,41 +34,46 @@ jobs:
             docs/**/*.md
             docs/**/*.mdx
 
-      - name: List all changed files
-        env:
-          ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
-        run: |
-          for file in ${ALL_CHANGED_FILES}; do
-            echo "$file was changed"
-          done
-
-  # Test the changed files
-  test:
+  # Clone the doc repo to test
+  cloneDocRepo:
     runs-on: ubuntu-latest
-    needs: getChangedFiles
-    if: ${{ needs.getChangedFiles.outputs.files != '' }}
     steps:
-      # Clone the repo and install dependencies
+    # Clone the repo and install dependencies
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
           node-version: 20
       # - run: npm ci
 
-      # Clone tests from https://gitlab.com/nomadic-labs/doclib
-      # Uses https://github.com/marketplace/actions/any-clone-repo
-      - name: Clone test repo
-        uses: chihqiang/checkout-action@main
-        with:
-          repo: https://gitlab.com/nomadic-labs/doclib.git
-          branch: main
-          dest: doclib
-      - name: Install test repo dependencies
-        working-directory: doclib
-        run : npm ci
+  # Clone and set up repo with doc tests
+  setUpTests:
+    runs-on: ubuntu-latest
+    # Clone tests from https://gitlab.com/nomadic-labs/doclib
+    # Uses https://github.com/marketplace/actions/any-clone-repo
+    - name: Clone test repo
+      uses: chihqiang/checkout-action@main
+      with:
+        repo: https://gitlab.com/nomadic-labs/doclib.git
+        branch: main
+        dest: doclib
+    - name: Install test repo dependencies
+      working-directory: doclib
+      run : npm ci
+
+  # Test the changed files
+  test:
+    runs-on: ubuntu-latest
+    needs: [getChangedFiles, setUpTests, cloneDocRepo]
+    if: ${{ needs.getChangedFiles.outputs.files != '' }}
+    steps:
 
       # Run tests
-      - name: Run used image check
+      - name: Run image link check
         working-directory: doclib
-        run: npm run usedImages -- --baseFolder=${{ github.workspace }} --docFiles=${{ needs.getChangedFiles.outputs.files }} --imageFolder=${{ env.STATIC_FOLDER }}
+        # Here, --docFiles is the list of changed files so the test checks the links to images in only those files
+        run: npm run imageLinks -- --baseFolder=${{ github.workspace }} --docFiles=${{ needs.getChangedFiles.outputs.files }} --imageFolder=${{ env.STATIC_FOLDER }}
 
+      - name: Run unused image check
+        working-directory: doclib
+        # Here, --docFiles is the folder where all of the doc files are so the test can check that no images have become abandoned
+        run: npm run usedImages -- --baseFolder=${{ github.workspace }} --docFiles=${{ env.DOCS_FOLDER }} --imageFolder=${{ env.STATIC_FOLDER }} --ignoreImages=${{ env.IGNORE_IMAGES }}