Improve CI: use npm ci, cache npm deps, confirm npm run package was run

Author: GaryGSC

.github/workflows/ci.yaml

@@ -1,4 +1,5 @@
 name: CI
+
 on:
   pull_request:
   push:
@@ -7,6 +8,7 @@ on:
       - 'v*'
 env:
   node_version: "20.x"
+  FORCE_COLOR: 3
 
 jobs:
   build: # make sure build/ci work properly
@@ -19,12 +21,17 @@ jobs:
         with:
           node-version: ${{ env.node_version }}
 
-      - name: npm install
-        run: npm install
+      - name: npm ci
+        run: npm ci --prefer-offline
 
-      - name: npm run pack
+      - name: npm run package
         run: npm run package
 
+      - name: Check for any changed files
+        run: |
+          [[ -z $(git status --untracked-files=no --porcelain) ]] || \
+            (echo "::error title=npm run package::Files in the /dist directory shouldn't have changed. You forgot to run 'npm run package'." && exit 1)
+
   audit:
     name: Audit
     runs-on: ubuntu-latest
@@ -36,6 +43,8 @@ jobs:
         with:
           node-version: ${{ env.node_version }}
 
+      # We don't need to install deps to audit them
+
       - name: npm audit
         run: npm audit --audit-level=critical
 
@@ -49,15 +58,16 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ env.node_version }}
+          cache: npm
+          cache-dependency-path: '**/package-lock.json'
 
-      - name: npm install
-        run: npm install
+      - name: npm ci
+        run: npm ci --prefer-offline
 
       - name: npm lint
         run: npm run lint
 
-# When tests are added to the code uncomment
-#  test-code:
+#  test:
 #    name: Test
 #    runs-on: ubuntu-latest
 #    steps:
@@ -67,9 +77,14 @@ jobs:
 #        uses: actions/setup-node@v4
 #        with:
 #          node-version: ${{ env.node_version }}
+#          cache: npm
+#          cache-dependency-path: '**/package-lock.json'
 #
-#      - name: npm install
-#        run: npm install
+#      - name: npm ci
+#        run: npm ci --prefer-offline
 #
 #      - name: npm test
 #        run: npm test
+#
+#      - name: Report test coverage to Codecov
+#        uses: codecov/codecov-action@v3