ci(workflow): add cache to workflows using actions/setup-node

.github/workflows/browser-test.yml

@@ -5,12 +5,11 @@ name: Browser Tests
 # **Who does it impact**: Docs engineering, open-source engineering contributors.
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: null
   push:
     branches:
       - main
-  pull_request:
-
+  pull_request: null
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -24,6 +23,7 @@ jobs:
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Get npm cache directory
         id: npm-cache

.github/workflows/dry-run-sync-algolia-search-indices.yml

@@ -5,8 +5,7 @@ name: (Dry run) Algolia
 # **Who does it impact**: Docs engineering.
 
 on:
-  workflow_dispatch:
-
+  workflow_dispatch: null
 jobs:
   updateIndices:
     name: (Dry run) Update indices
@@ -18,6 +17,7 @@ jobs:
       - uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
       - name: cache node modules
         uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
         with:

.github/workflows/js-lint.yml

@@ -5,12 +5,11 @@ name: Lint JS
 # **Who does it impact**: Docs engineering, open-source engineering contributors.
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: null
   push:
     branches:
       - main
-  pull_request:
-
+  pull_request: null
 jobs:
   lint:
     runs-on: ubuntu-latest
@@ -22,6 +21,7 @@ jobs:
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Get npm cache directory
         id: npm-cache

.github/workflows/link-check-dotcom.yml

@@ -1,19 +1,20 @@
-name: 'Link Checker: Dotcom'
+name: "Link Checker: Dotcom"
 
 # **What it does**: This checks links for dotcom version of docs.
 # **Why we have it**: We want to know if links break.
 # **Who does it impact**: Docs content.
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: null
   push:
     branches:
       - main
-  pull_request:
-
+  pull_request: null
 jobs:
   build:
-    runs-on: ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
+    runs-on:
+      ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository ==
+      'github/docs-internal'] }}
     steps:
       # Each of these ifs needs to be repeated at each step to make sure the required check still runs
       # Even if if doesn't do anything
@@ -24,14 +25,15 @@ jobs:
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Install
         run: npm ci
 
       - name: Build
         run: npm run build
 
-      - name: 'Link check: Dotcom'
+      - name: "Link check: Dotcom"
         env:
-          DOCS_VERSION: 'dotcom'
+          DOCS_VERSION: "dotcom"
         run: npm run link-check

.github/workflows/link-check-ghae.yml

@@ -1,19 +1,20 @@
-name: 'Link Checker: GitHub AE'
+name: "Link Checker: GitHub AE"
 
 # **What it does**: This checks links for GHAE version of docs.
 # **Why we have it**: We want to know if links break.
 # **Who does it impact**: Docs content.
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: null
   push:
     branches:
       - main
-  pull_request:
-
+  pull_request: null
 jobs:
   build:
-    runs-on: ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
+    runs-on:
+      ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository ==
+      'github/docs-internal'] }}
     steps:
       # Each of these ifs needs to be repeated at each step to make sure the required check still runs
       # Even if if doesn't do anything
@@ -24,14 +25,15 @@ jobs:
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Install
         run: npm ci
 
       - name: Build
         run: npm run build
 
-      - name: 'Link check: GitHub AE'
+      - name: "Link check: GitHub AE"
         env:
-          DOCS_VERSION: 'github-ae'
+          DOCS_VERSION: "github-ae"
         run: npm run link-check

.github/workflows/link-check-ghes.yml

@@ -1,19 +1,20 @@
-name: 'Link Checker: Enterprise Server'
+name: "Link Checker: Enterprise Server"
 
 # **What it does**: This checks links for GHES version of docs.
 # **Why we have it**: We want to know if links break.
 # **Who does it impact**: Docs content.
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: null
   push:
     branches:
       - main
-  pull_request:
-
+  pull_request: null
 jobs:
   build:
-    runs-on: ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
+    runs-on:
+      ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository ==
+      'github/docs-internal'] }}
     steps:
       # Each of these ifs needs to be repeated at each step to make sure the required check still runs
       # Even if if doesn't do anything
@@ -24,14 +25,15 @@ jobs:
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Install
         run: npm ci
 
       - name: Build
         run: npm run build
 
-      - name: 'Link check: Enterprise Server'
+      - name: "Link check: Enterprise Server"
         env:
-          DOCS_VERSION: 'enterprise-server'
+          DOCS_VERSION: "enterprise-server"
         run: npm run link-check

.github/workflows/pa11y.yml

@@ -5,12 +5,13 @@ name: Pa11y
 # **Who does it impact**: Docs engineering, users who need accessibility features.
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: null
   schedule:
-    - cron: '25 17 * * *' # once a day at 17:25 UTC / 11:50 PST
+    - cron: "25 17 * * *" # once a day at 17:25 UTC / 11:50 PST
 jobs:
   test:
-    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
+    if: github.repository == 'github/docs-internal' || github.repository ==
+      'github/docs'
     runs-on: ubuntu-latest
     steps:
       - name: Check out repo
@@ -20,6 +21,7 @@ jobs:
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Get npm cache directory
         id: npm-cache

.github/workflows/staging-deploy-pr.yml

@@ -14,17 +14,18 @@ on:
   workflow_dispatch:
     inputs:
       pullRequestUrl:
-        description: 'Pull Request URL'
+        description: "Pull Request URL"
         required: true
-        default: 'https://github.com/github/docs/pull/1234'
+        default: "https://github.com/github/docs/pull/1234"
       forceRebuild:
-        description: 'Force the Heroku App to be rebuilt from scratch? (true/false)'
+        description: "Force the Heroku App to be rebuilt from scratch? (true/false)"
         required: false
-        default: 'false'
+        default: "false"
 
 jobs:
   validate-inputs:
-    if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }}
+    if: ${{ github.repository == 'github/docs-internal' || github.repository ==
+      'github/docs' }}
     name: Validate inputs
     runs-on: ubuntu-latest
     timeout-minutes: 2
@@ -36,13 +37,14 @@ jobs:
         uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
         with:
           # Enables cloning the Early Access repo later with the relevant PAT
-          persist-credentials: 'false'
+          persist-credentials: "false"
 
       - if: ${{ github.event_name == 'workflow_dispatch' }}
         name: Setup node
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - if: ${{ github.event_name == 'workflow_dispatch' }}
         name: Get npm cache directory
@@ -95,7 +97,8 @@ jobs:
             core.setOutput('headRef', pullRequest.head.ref)
 
   deploy:
-    if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }}
+    if: ${{ github.repository == 'github/docs-internal' || github.repository ==
+      'github/docs' }}
     needs: validate-inputs
     name: Deploy
     runs-on: ubuntu-latest
@@ -108,12 +111,13 @@ jobs:
         uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
         with:
           # Enables cloning the Early Access repo later with the relevant PAT
-          persist-credentials: 'false'
+          persist-credentials: "false"
 
       - name: Setup node
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Get npm cache directory
         id: npm-cache

.github/workflows/staging-undeploy-pr.yml

@@ -12,7 +12,8 @@ on:
 
 jobs:
   undeploy:
-    if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }}
+    if: ${{ github.repository == 'github/docs-internal' || github.repository ==
+      'github/docs' }}
     name: Undeploy
     runs-on: ubuntu-latest
     timeout-minutes: 2
@@ -24,12 +25,13 @@ jobs:
         uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
         with:
           # Enables cloning the Early Access repo later with the relevant PAT
-          persist-credentials: 'false'
+          persist-credentials: "false"
 
       - name: Setup node
         uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Get npm cache directory
         id: npm-cache

.github/workflows/sync-algolia-search-indices.yml

@@ -5,7 +5,7 @@ name: Algolia
 # **Who does it impact**: Anyone using search on docs.
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: null
   push:
     branches:
       - main
@@ -21,6 +21,7 @@ jobs:
       - uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
       - name: cache node modules
         uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
         with:
@@ -45,4 +46,6 @@ jobs:
           channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
           bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
           color: failure
-          text: The last Algolia workflow run for ${{github.repository}} failed. Search actions for `workflow:Algolia`
+          text:
+            The last Algolia workflow run for ${{github.repository}} failed. Search
+            actions for `workflow:Algolia`

.github/workflows/sync-single-english-algolia-index.yml

@@ -27,6 +27,7 @@ jobs:
       - uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
         with:
           node-version: 16.x
+          cache: npm
       - name: cache node modules
         uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
         with:
@@ -36,14 +37,16 @@ jobs:
             ${{ runner.os }}-node-
       - name: npm ci
         run: npm ci
-      - name: Get version from Algolia label if present; only continue if the label is found.
+      - name:
+          Get version from Algolia label if present; only continue if the label is
+          found.
         id: getVersion
         run: $GITHUB_WORKSPACE/.github/actions-scripts/enterprise-algolia-label.js
       - if: ${{ steps.getVersion.outputs.versionToSync }}
         name: Sync English index for single version
         env:
           VERSION: ${{ steps.getVersion.outputs.versionToSync }}
-          LANGUAGE: 'en'
+          LANGUAGE: "en"
           ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
           ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}