chore: simplify and standardize package.json scripts and CI setup (#7069)

* chore(package.json): simplify site build

There were two separate scripts for doing the same thing.

* refactor(scripts): split up prepare-for-publish

No behavioural changes in this commit.

* chore: remove bizarre postinstall hook that builds

- It's nonstandard
- It's surprising
- Since we use `tsc` to build, it causes every CI check to fail if you have type errors
- It causes issues when rewriting git history
- It's a bit magical

* chore: remove leftover refs to ava

ava was removed a couple years ago

* ci: rename misleading jobs

They handle two kinds of benchmarks, only one of which is package size

* chore: split formating, linting, and unit testing

* ci: simplify workflow skipping for release branches

* chore(package.json): sort scripts

* chore(deps): add missing dependency on npm-run-all

We're using `run-s` which comes from this dep but it only happens to work because one of
our dependencies has a transitive dependency on `npm-run-all`.

IMO we should kill this, but for now this just adds the missing dep.

Note: npm-run-all2 is a maintained fork of the unmaintained npm-run-all

Author: serhalp

.github/workflows/benchmark-post.yml

@@ -6,7 +6,7 @@ on:
       - completed
 
 jobs:
-  post-package-size:
+  post-benchmarks:
     runs-on: ubuntu-latest
     steps:
       # This posts the status to the PR/commit

.github/workflows/benchmark.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
     branches: [main]
 jobs:
-  package-size:
+  calculate-benchmarks:
     if: startsWith(github.head_ref, 'release-please') == false
     runs-on: ubuntu-latest
     steps:

.github/workflows/e2e-tests.yml

@@ -41,6 +41,8 @@ jobs:
           key: verdaccio-e2e-cli-${{ hashFiles('./package-lock.json') }}
       - name: Install dependencies
         run: npm ci --no-audit
+      - name: Build package
+        run: npm run build
       - run: npm run e2e
       - name: Notify Slack
         uses: 8398a7/action-slack@v3
@@ -89,6 +91,8 @@ jobs:
           key: verdaccio-e2e-cli-${{ hashFiles('./package-lock.json') }}
       - name: Install dependencies
         run: npm ci --no-audit
+      - name: Build package
+        run: npm run build
       - run: npm run e2e
       - name: Notify Slack
         uses: 8398a7/action-slack@v3

.github/workflows/format.yml

@@ -0,0 +1,24 @@
+name: Format
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  format:
+    name: Format
+    if: "${{ !startsWith(github.head_ref, 'release-') }}"
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install core dependencies
+        run: npm ci --no-audit
+      - name: Check format
+        run: npm run format

.github/workflows/integration-tests.yml

@@ -9,6 +9,7 @@ on:
 jobs:
   integration:
     name: Integration
+    if: "${{ !startsWith(github.head_ref, 'release-') }}"
     runs-on: ${{ matrix.os }}
     timeout-minutes: 40
     strategy:
@@ -27,55 +28,41 @@ jobs:
             node-version: '22'
       fail-fast: false
     steps:
-      # Sets an output parameter if this is a release PR
-      - name: Check for release
-        id: release-check
-        # For windows we have to use $env:
-        run: |-
-          echo "IS_RELEASE=true" >> $GITHUB_OUTPUT
-          echo "IS_RELEASE=true" >> $env:GITHUB_OUTPUT
-        if: "${{ startsWith(github.head_ref, 'release-') }}"
       # This improves Windows network performance, we need this since we open many ports in our tests
       - name: Increase Windows port limit and reduce time wait delay
         run: |
           netsh int ipv4 set dynamicport tcp start=1025 num=64511
           REG ADD HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\TCPIP\Parameters /v TcpTimedWaitDelay /t REG_DWORD /d 30 /f
-        if: "${{ matrix.os == 'windows-latest' && !steps.release-check.outputs.IS_RELEASE }}"
+        if: "${{ matrix.os == 'windows-latest' }}"
       - name: Git checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: npm
           check-latest: true
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
       - name: Install PNPM
         run: |
           corepack enable
           corepack prepare [email protected] --activate
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
       - name: Setup Deno
         uses: denoland/setup-deno@v1
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
         with:
           deno-version: v1.44.4
       - name: Install core dependencies
         run: npm ci --no-audit
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
+      - name: Build package
+        run: npm run build
       - name: Generate self-signed certificates
         run: npm run certs
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
         shell: bash
       - name: Prepare tests
         run: npm run test:init
-        if: '${{ !steps.release-check.outputs.IS_RELEASE }}'
       - name: Tests
         uses: nick-fields/retry@v3
-        if: '${{ !steps.release-check.outputs.IS_RELEASE }}'
         with:
           timeout_minutes: 15
           max_attempts: 3
@@ -103,7 +90,6 @@ jobs:
           echo "node=node_${node/.*.*/}" >> $GITHUB_OUTPUT
           echo "node=node_${node/.*.*/}" >> $env:GITHUB_OUTPUT
         shell: bash
-        if: '${{ !steps.release-check.outputs.IS_RELEASE }}'
 
       - name: Sanitize shard for artefact name
         id: sanitize-shard-name
@@ -122,22 +108,14 @@ jobs:
         with:
           flags: ${{ steps.test-coverage-flags.outputs.os }},${{ steps.test-coverage-flags.outputs.node }}
           token: ${{ secrets.CODECOV_TOKEN }}
-        if: '${{ !steps.release-check.outputs.IS_RELEASE }}'
   # Specific tests for known test that failed on windows using node 23.
   # Can be replaced with larger node 23 tests in the future.
   integration-win-node-23:
     name: Integration test windows latest node23 specific
+    if: "${{ !startsWith(github.head_ref, 'release-') }}"
     runs-on: windows-latest
     timeout-minutes: 40
     steps:
-      # Sets an output parameter if this is a release PR
-      - name: Check for release
-        id: release-check
-        # For windows we have to use $env:
-        run: |-
-          echo "IS_RELEASE=true" >> $GITHUB_OUTPUT
-          echo "IS_RELEASE=true" >> $env:GITHUB_OUTPUT
-        if: "${{ startsWith(github.head_ref, 'release-') }}"
       # This improves Windows network performance, we need this since we open many ports in our tests
       - name: Increase Windows port limit and reduce time wait delay
         run: |
@@ -147,37 +125,31 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
           node-version: '23.x'
           cache: npm
           check-latest: true
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
       - name: Install PNPM
         run: |
           corepack enable
           corepack prepare [email protected] --activate
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
       - name: Setup Deno
         uses: denoland/setup-deno@v1
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
         with:
           deno-version: v1.44.4
       - name: Install core dependencies
         run: npm ci --no-audit
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
+      - name: Build package
+        run: npm run build
       - name: Generate self-signed certificates
         run: npm run certs
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
         shell: bash
       - name: Prepare tests
         run: npm run test:init
-        if: '${{ !steps.release-check.outputs.IS_RELEASE }}'
       - name: Tests
         uses: nick-fields/retry@v3
-        if: '${{ !steps.release-check.outputs.IS_RELEASE }}'
         with:
           timeout_minutes: 15
           max_attempts: 3
@@ -205,7 +177,6 @@ jobs:
           echo "node=node_${node/.*.*/}" >> $GITHUB_OUTPUT
           echo "node=node_${node/.*.*/}" >> $env:GITHUB_OUTPUT
         shell: bash
-        if: '${{ !steps.release-check.outputs.IS_RELEASE }}'
 
       - name: Store npm error artefacts
         uses: actions/upload-artifact@v4
@@ -220,4 +191,3 @@ jobs:
         with:
           flags: ${{ steps.test-coverage-flags.outputs.os }},${{ steps.test-coverage-flags.outputs.node }}
           token: ${{ secrets.CODECOV_TOKEN }}
-        if: '${{ !steps.release-check.outputs.IS_RELEASE }}'

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Lint
+    if: "${{ !startsWith(github.head_ref, 'release-') }}"
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install core dependencies
+        run: npm ci --no-audit
+      - name: Run lint
+        run: npm run lint

.github/workflows/unit-tests.yml

@@ -9,6 +9,7 @@ on:
 jobs:
   unit:
     name: Unit
+    if: "${{ !startsWith(github.head_ref, 'release-') }}"
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -19,35 +20,22 @@ jobs:
             node-version: '22.x'
       fail-fast: false
     steps:
-      # Sets an output parameter if this is a release PR
-      - name: Check for release
-        id: release-check
-        # For windows we have to use $env:
-        run: |-
-          echo "IS_RELEASE=true" >> $GITHUB_OUTPUT
-          echo "IS_RELEASE=true" >> $env:GITHUB_OUTPUT
-        if: "${{ startsWith(github.head_ref, 'release-') }}"
       - name: Git checkout
         uses: actions/checkout@v4
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: npm
           check-latest: true
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
       - name: Install core dependencies
         run: npm ci --no-audit
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
-      - name: Linting
-        run: npm run format:ci
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'
+      - name: Build package
+        run: npm run build
       - name: Run unit tests
         uses: nick-fields/retry@v3
         with:
           timeout_minutes: 15
           max_attempts: 3
           retry_on: error
           command: npm run test:ci:vitest:unit
-        if: '${{!steps.release-check.outputs.IS_RELEASE}}'

.github/workflows/verify-docs.yml

@@ -20,15 +20,13 @@ jobs:
           cache: npm
       - name: Install core dependencies
         run: npm ci --no-audit
-      - name: Install site dependencies
-        run: npm run site:build:install
       - name: Generate docs
-        run: npm run docs
+        run: npm run site:build
       - name: Check for changes
         run: |
           if [ -z "$(git status --porcelain)" ]; then
             echo "No changes to docs files detected"
           else
-            echo "Changes to docs files detected, please run 'npm run docs' to sync docs"
+            echo "Changes to docs files detected, please run 'npm run site:build' to sync docs"
             exit 1
           fi

CONTRIBUTING.md

@@ -24,7 +24,6 @@ promote a positive and inclusive environment.
 - [Releasing](#releasing)
 - [License](#license)
 
-
 ## Developing locally
 
 First, fork and clone the repository. If you’re not sure how to do this, please watch
@@ -33,7 +32,7 @@ First, fork and clone the repository. If you’re not sure how to do this, pleas
 Run:
 
 ```bash
-npm install && npm run site:build:install
+npm install && npm run build
 ```
 
 Tests are run with:
@@ -73,6 +72,7 @@ to run ESLint and Prettier automatically on file save. Otherwise, you should run
 
 ```bash
 npm run format
+npm run lint
 ```
 
 Alternatively, you can set up your IDE to integrate with Prettier and ESLint for JavaScript and Markdown files.
@@ -91,11 +91,14 @@ DEBUG=true ./bin/run.js [command]
 
 ### Attaching a Debugger
 
-When debugging a project, it's super helpful to attach a debugger to the CLI. If you use VS Code, here's how you can do it:
+When debugging a project, it's super helpful to attach a debugger to the CLI. If you use VS Code, here's how you can do
+it:
 
 1. Open this repository in VS Code.
-2. Open a "JavaScript Debug Terminal" (e.g. by searching for it in the Command Palette (Shift-Cmd+P)). Every Node process that's opened in this terminal will have a debugger attached.
-3. Place a breakpoint somewhere in the CLI. You will have to place them in the compiled `.js` files as opposed to the `.ts` files.
+2. Open a "JavaScript Debug Terminal" (e.g. by searching for it in the Command Palette (Shift-Cmd+P)). Every Node
+   process that's opened in this terminal will have a debugger attached.
+3. Place a breakpoint somewhere in the CLI. You will have to place them in the compiled `.js` files as opposed to the
+   `.ts` files.
 4. In your JavaScript Debug Terminal, navigate to the project you'd like to debug.
 5. Run `/path/to/netlify/cli/bin/run.js`. The debugger should be connecting automatically.
 
@@ -113,9 +116,10 @@ A good place to start is reading the base command README and looking at the comm
 
 > If you’d like to learn more on how `netlify dev` works, check [here](./docs/netlify-dev.md)
 
-
 ### Adding or updating a command
-If you're adding a new command or updating an existing one, make sure to also add docs for it by running `npm run site:build`.
+
+If you're adding a new command or updating an existing one, make sure to also add docs for it by running
+`npm run site:build`.
 
 This will automatically generate documentation for you that will look like the following:
 
@@ -130,17 +134,18 @@ description: A description.
 <!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
 
 <!-- AUTO-GENERATED-CONTENT:END -->
-
 ```
 
-When adding a new command, you will also need to add it to the nav sidebar manually by adding it to the `navOrder` array in `site/src/_app.js`
+When adding a new command, you will also need to add it to the nav sidebar manually by adding it to the `navOrder` array
+in `site/src/_app.js`
 
 ### Updating our documentation
 
 If documentation looks to be out of date, it is likely that the code for the command itself is not correct.
 
-To update the documentation, update the code (rather than the markdown files) and then run `npm run docs` to sync the docs. To confirm that the changes to the docs are correct, run `cd site && npm run dev:start` to run the docs locally.
-
+To update the documentation, update the code (rather than the markdown files) and then run `npm run site:build` to sync
+the docs. To confirm that the changes to the docs are correct, run `cd site && npm run dev:start` to run the docs
+locally.
 
 ### Testing
 
@@ -200,7 +205,8 @@ We actively welcome your pull requests.
 
 ## Releasing
 
-Tag the 'release' pull request using the `automerge` label. This will merge the pull request on GitHub and publish the package to npm.
+Tag the 'release' pull request using the `automerge` label. This will merge the pull request on GitHub and publish the
+package to npm.
 
 ### Creating a prerelease