From 8e2898b4f62994a5121d9deca599f2134a37ab8b Mon Sep 17 00:00:00 2001 From: Pedro Lobato <69770518+Lob26@users.noreply.github.com> Date: Mon, 7 Sep 2026 10:48:55 -0500 Subject: [PATCH] docs: install the pinned pnpm without Corepack MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Node.js 25 dropped the bundled Corepack, so `corepack install --global pnpm@11.20.0` — the first command of every documented setup path — fails outright on a current Node release. The contributor is left with neither pnpm nor a reason, and nothing in the docs says which Node line to use instead. Install the same pinned version with npm, which is present on every supported release, and state the constraint where the prerequisites are listed: Node.js 25 and later are outside the supported range, and `.nvmrc` selects a line that is inside it. The local development guide already told readers not to substitute npm for pnpm, so it now distinguishes installing pnpm from running the workspace with it. --- CONTRIBUTING.md | 11 +++++++---- README.md | 7 ++++--- apps/docs/docs/reference/reference-fixture.md | 2 +- apps/docs/docs/self-host/local-development.md | 10 ++++++---- apps/docs/docs/self-host/quickstart.md | 7 ++++--- 5 files changed, 22 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af0b7038..3406af1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,14 +27,17 @@ technical problem on its own terms and the private tracker links to it. ## Set up the repository The monorepo recommends Node.js 24 LTS and uses pnpm 11.20.0. Node.js 22 is -also supported from 22.13.0. Docker is required for the local platform stack -and workspace end-to-end tests. For nvm users, the repository's `.nvmrc` selects -the recommended Node.js 24 line with `nvm use`. +also supported from 22.13.0. Node.js 25 and later fall outside that range and +no longer bundle Corepack, so `corepack enable` is not available there; the +command below installs the pinned pnpm on every supported release. Docker is +required for the local platform stack and workspace end-to-end tests. For nvm +users, the repository's `.nvmrc` selects the recommended Node.js 24 line with +`nvm use`. ```bash git clone https://github.com/theam/facility.git cd facility -corepack install --global pnpm@11.20.0 +npm install --global pnpm@11.20.0 pnpm dev ``` diff --git a/README.md b/README.md index f5573c89..b6321398 100644 --- a/README.md +++ b/README.md @@ -219,14 +219,15 @@ Bearer header. Running Facility locally takes one command for the stack, a runner image for story workspaces, and a GitHub App when you want to use a real repository. You need Docker, Node.js 24 LTS, and the -repository-pinned pnpm 11.20.0. Node.js 22 is supported from 22.13.0. +repository-pinned pnpm 11.20.0. Node.js 22 is supported from 22.13.0. Node.js 25 and later are +outside the supported range and no longer bundle Corepack; `.nvmrc` selects a supported line. ### 1. Clone and boot the stack ```bash git clone https://github.com/theam/facility.git cd facility -corepack install --global pnpm@11.20.0 +npm install --global pnpm@11.20.0 pnpm dev ``` @@ -467,7 +468,7 @@ behavior and boundaries can be agreed on. ```bash git clone https://github.com/theam/facility.git cd facility -corepack install --global pnpm@11.20.0 +npm install --global pnpm@11.20.0 pnpm install --frozen-lockfile pnpm verify ``` diff --git a/apps/docs/docs/reference/reference-fixture.md b/apps/docs/docs/reference/reference-fixture.md index d1bad731..95682e43 100644 --- a/apps/docs/docs/reference/reference-fixture.md +++ b/apps/docs/docs/reference/reference-fixture.md @@ -12,7 +12,7 @@ sample builder and scheduled-security agents. It has no network or credential de From a clean checkout, run: ```bash -corepack install --global pnpm@11.20.0 +npm install --global pnpm@11.20.0 pnpm install --frozen-lockfile docker build -f runner/Dockerfile -t facility-runner:dev . FACILITY_E2E_DOCKER=1 \ diff --git a/apps/docs/docs/self-host/local-development.md b/apps/docs/docs/self-host/local-development.md index 65f99e60..13f7eee4 100644 --- a/apps/docs/docs/self-host/local-development.md +++ b/apps/docs/docs/self-host/local-development.md @@ -12,12 +12,14 @@ This guide covers work on the Facility monorepo. If you only want to run the pro Install Node.js 24 LTS and pnpm 11.20.0 before running the repository: ```bash -corepack install --global pnpm@11.20.0 +npm install --global pnpm@11.20.0 ``` -The root `package.json` also accepts Node.js 22 from 22.13.0. Use the repository `.nvmrc` when -working with nvm. Do not substitute npm or yarn: the lockfile, workspace filters, and verification -scripts assume pnpm. +The root `package.json` also accepts Node.js 22 from 22.13.0. Node.js 25 and later are outside that +range and no longer bundle Corepack; use the repository `.nvmrc` to select a supported line when +working with nvm. npm appears above only to install the pinned pnpm, which works on every supported +release. Do not substitute npm or yarn for pnpm itself: the lockfile, workspace filters, and +verification scripts assume pnpm. Clone the repository, then run: diff --git a/apps/docs/docs/self-host/quickstart.md b/apps/docs/docs/self-host/quickstart.md index 04828f4a..0a89f599 100644 --- a/apps/docs/docs/self-host/quickstart.md +++ b/apps/docs/docs/self-host/quickstart.md @@ -11,14 +11,15 @@ guide](production.md) before exposing an instance to other users or repositories Install Docker, Node.js 24, and the repository-pinned pnpm version. -Node.js 22 is also supported from 22.13.0. Docker must be running and the current user must be able -to use it. Local story workspaces require enough disk for repository checkouts, dependencies, +Node.js 22 is also supported from 22.13.0. Node.js 25 and later are outside the supported range and +no longer bundle Corepack; use `.nvmrc` to select a supported line. Docker must be running and the +current user must be able to use it. Local story workspaces require enough disk for repository checkouts, dependencies, nested Docker images, and persistent volumes. ## Start the local stack ```bash -corepack install --global pnpm@11.20.0 +npm install --global pnpm@11.20.0 pnpm install --frozen-lockfile cp .env.example .env docker build -f runner/Dockerfile -t facility-runner:dev .