CI: make netlify-cli optional (#3084)

Co-authored-by: Phillip Carter <[email protected]>

.github/workflows/check-format.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Create NPM cache-hash input file
         run: |
           mkdir -p tmp
-          jq '{devDependencies, dependencies, engines}' package.json > tmp/package-ci.json
+          jq '{devDependencies, dependencies, engines, gitHubActionCacheKey}' package.json > tmp/package-ci.json
 
       - uses: actions/setup-node@v3
         with:

.github/workflows/check-links.yml

@@ -20,7 +20,7 @@ jobs:
           jq '.devDependencies |= with_entries(
                   select(.key | test("prefix|hugo|run|css"))
                 )
-                | del(.dependencies)' \
+                | del(.dependencies, .optionalDependencies)' \
             package.json > tmp/package-min.json
           cp tmp/package-min.json package.json
 
@@ -30,7 +30,7 @@ jobs:
           cache: npm
           cache-dependency-path: tmp/package-ci.json
 
-      - run: npm install --no-optional
+      - run: npm install --omit=optional
       - run: npm run build+log
       - run: npm run _check:links
         continue-on-error: true

.github/workflows/check-text.yml

@@ -11,8 +11,12 @@ jobs:
       - uses: actions/checkout@v3
       # Make sure that we only install the dependencies for textlint to speed up install
       - run: |
-          jq 'del(.dependencies) | .devDependencies |= with_entries( select(.key | startswith("textlint")))' package.json > package2.json && mv package2.json package.json
-      - run: npm install --ignore-scripts
+          mkdir -p tmp
+          jq '.devDependencies |= with_entries( select(.key | startswith("textlint")))
+              | del(.dependencies, .optionalDependencies)' \
+              package.json > tmp/package-min.json
+          cp tmp/package-min.json package.json
+      - run: npm install --ignore-scripts --omit=optional
       - run: .github/workflows/scripts/textlint.sh
 
   markdown-linter:
@@ -27,8 +31,8 @@ jobs:
           jq '.devDependencies |= with_entries(
                   select(.key | test("gulp|markdown|through|require|yargs"))
                 )
-                | del(.dependencies)' \
+                | del(.dependencies, .optionalDependencies)' \
             package.json > tmp/package-min.json
           cp tmp/package-min.json package.json
-      - run: npm install --ignore-scripts
+      - run: npm install --ignore-scripts --omit=optional
       - run: npm run check:markdown

.github/workflows/pr-actions.yml

@@ -36,22 +36,12 @@ jobs:
           mkdir -p tmp
           jq '{devDependencies, dependencies, engines, gitHubActionCacheKey}' package.json > tmp/package-ci.json
 
-      # - name: Create and use reduced-dependencies package.json
-      #   run: |
-      #     jq '.devDependencies |= with_entries(
-      #             select(.key | test("prefix|hugo|run|css|prettier"))
-      #           )
-      #           | del(.dependencies)' \
-      #       package.json > tmp/package-min.json
-      #     cp tmp/package-min.json package.json
-
       - uses: actions/setup-node@v3
         with:
           node-version-file: .nvmrc
           cache: npm
           cache-dependency-path: tmp/package-ci.json
 
-      # - run: npm install --no-optional --ignore-scripts
       - run: |
           npm run format
           git status
@@ -108,7 +98,7 @@ jobs:
           cache: npm
           cache-dependency-path: tmp/package-ci.json
 
-      - run: npm install
+      - run: npm install --omit=optional
       - run: |
           npm run check:links
           git status

package.json

@@ -49,6 +49,7 @@
     "fix:filenames": "npm run _rename-to-kebab-case",
     "format": "npm run _check:format -- --write",
     "get:submodule": "npm run _get:${GET:-submodule}",
+    "install:netlify-cli": "npm list netlify-cli || npm install netlify-cli",
     "make:public": "make public ls-public",
     "postbuild:preview": "npm run _check:links--warn",
     "postbuild:production": "npm run _check:links--warn",
@@ -60,7 +61,7 @@
     "precheck:links:internal": "npm run build",
     "prepare": "run-s get:submodule _prepare:docsy",
     "preserve:hugo": "npm run _prebuild",
-    "preserve:netlify": "npm run _prebuild",
+    "preserve:netlify": "run-s _prebuild install:netlify-cli",
     "s": "run-s",
     "schemas:update": "npm run update:submodule content-modules/opentelemetry-specification",
     "serve:hugo": "npm run _serve:hugo",
@@ -70,7 +71,7 @@
     "update:pkg:docsy-dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest",
     "update:pkg:hugo": "npm install --save-dev --save-exact hugo-extended@latest",
     "update:pkg:hugo+": "npm run update:pkg:hugo && npm run update:pkg:docsy-dep",
-    "update:pkg:netlify": "npm install --save-dev netlify-cli@latest",
+    "update:pkg:netlify": "npm install --save-optional netlify-cli@latest",
     "update:pkg:other": "npm install --save-dev npm-run-all@latest gulp@latest",
     "update:submodule:lang": "run-s update:submodule _get:submodule:non-lang",
     "update:submodule": "set -x && git submodule update --remote ${DEPTH:- --depth 1}"
@@ -81,7 +82,6 @@
     "gulp": "^4.0.2",
     "hugo-extended": "0.115.4",
     "markdownlint": "^0.29.0",
-    "netlify-cli": "^15.9.1",
     "npm-run-all": "^4.1.5",
     "postcss-cli": "^10.1.0",
     "prettier": "^3.0.0",
@@ -105,6 +105,9 @@
     "@opentelemetry/sdk-trace-web": "^1.8.0",
     "@opentelemetry/semantic-conventions": "^1.8.0"
   },
+  "optionalDependencies": {
+    "netlify-cli": "^15.9.1"
+  },
   "enginesComment": "Ensure that engines.node value stays consistent with the project's .nvmrc",
   "engines": {
     "node": "18.x"