Check auto-generated docs for changes (#17)

* new check-docs.yaml workflow

* make check-docs.yaml a valid workflow

* fix README

.github/workflows/check-dist.yaml

@@ -19,7 +19,7 @@ jobs:
   check-dist:
     runs-on: ubuntu-latest
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         path:
           - 'determine-environment'
@@ -28,7 +28,7 @@ jobs:
           - 'get-package-version'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set Node.js 16.x
         uses: actions/setup-node@v3

.github/workflows/check-docs.yaml

@@ -0,0 +1,33 @@
+name: Check generated docs
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set Node.js 16.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: npm
+          cache-dependency-path: package-lock.json
+
+      - name: Install dependencies
+        run: npm install --prefer-offline --frozen-lockfile
+
+      - name: Regenerate all READMEs
+        run: npm run docs
+
+      - name: Compare the expected and actual READMEs
+        run: |
+          if [ "$(git diff --ignore-space-at-eol | wc -l)" -gt "0" ]; then
+            echo "Detected uncommitted changes after build.  See status below:"
+            git diff
+            exit 1
+          fi